Uwierzytelnianie

Korzystanie z Meshy API wymaga uwierzytelniania. Ten przewodnik pokaże Ci, jak utworzyć konto i klucze API.

Klucze API

Tworzenie konta Meshy

Meshy API wymaga posiadania konta Meshy, aby móc tworzyć i zarządzać kluczami API. Jeśli żądanie do API zostanie wysłane bez klucza API, API odpowie błędem nieprawidłowych danych uwierzytelniających.

Możesz utworzyć konto Meshy, odwiedzając oficjalną stronę Meshy i rejestrując się.

Tworzenie kluczy API

Po utworzeniu konta Meshy możesz tworzyć klucze API na stronie kluczy API w Developer Platform.

Możesz utworzyć wiele kluczy API do różnych celów. Na przykład możesz utworzyć jeden klucz API dla swojej aplikacji iOS, a drugi dla aplikacji webowej. Użycie każdego klucza API jest śledzone osobno i możesz je unieważnić w dowolnym momencie.

Możesz również ustawić miesięczny limit kredytów dla dowolnego klucza, ograniczając kwotę, jaką może on wydać, niezależnie od ogólnego wykorzystania Twojego konta — przydatne do ograniczenia uprawnień klucza przekazywanego zewnętrznemu wykonawcy lub konkretnemu środowisku.

Okno dialogowe tworzenia klucza API z opcjonalnym polem miesięcznego limitu kredytów

Aby utworzyć klucz API, kliknij przycisk Create API Key na stronie API, a następnie wprowadź nazwę swojego klucza API.

Po utworzeniu klucza API zostanie wyświetlona jego wartość. Możesz skopiować wartość klucza API i przechować ją w bezpiecznym miejscu.

Nie będziesz mógł ponownie zobaczyć tej wartości klucza API.

Używanie kluczy API

Po utworzeniu klucza API możesz go użyć do uwierzytelniania swoich żądań do Meshy API. Możesz przekazać swój klucz API do API w nagłówku Authorization, przykładowy nagłówek pokazano poniżej.

{
  "Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}

Prefiks Bearer w wartości nagłówka jest obowiązkowy do programowej interakcji z Meshy API. Więcej informacji na ten temat znajdziesz w IETF RFC 6750

Bezpieczeństwo

W Meshy bardzo poważnie traktujemy bezpieczeństwo i ciężko pracujemy, aby zapewnić bezpieczeństwo Meshy API. Mamy nadzieję, że Twoje dane i dane Twoich użytkowników są u nas bezpieczne. Oto kilka ogólnych wskazówek, które pomogą Ci zachować bezpieczeństwo danych i żądań podczas korzystania z Meshy API, ale upewnij się również, że przestrzegasz wytycznych obowiązujących w Twoim zespole lub miejscu pracy.

Bezpieczeństwo warstwy transportowej

Chociaż Twoje dane są szyfrowane w spoczynku po zapisaniu ich w Meshy, Meshy API wykorzystuje i wymusza TLS, aby szyfrować dane podczas przesyłania. Oznacza to, że wszystkie żądania do i z Meshy API są wysyłane przez HTTPS, a każde żądanie wysłane przez HTTP otrzyma kod statusu 301 Moved Permanently. Choć nie jest to zalecane, w niektórych przypadkach, jeśli musisz komunikować się przez HTTP, musisz jawnie poinstruować swojego klienta HTTP, aby podążał za przekierowaniami z HTTP do HTTPS. Oto kilka przykładów:

Podążanie za przekierowaniami z HTTP do HTTPS

# use `-L` to follow HTTP to HTTPS redirections
curl -L https://api.meshy.ai/openapi/v1/balance \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Przekierowania działają tylko dla żądań GET: klienci HTTP ponownie wysyłają przekierowane żądanie POST jako GET bez jego treści, dlatego zawsze wywołuj https:// bezpośrednio podczas tworzenia zadań.

Bezpieczeństwo klucza API

Pamiętaj, że nawet zespół Meshy nie może wyświetlić ani odzyskać dla Ciebie unieważnionych kluczy API!

Po wygenerowaniu klucze API nie są już widoczne w panelu, dlatego prosimy o ich pobranie i bezpieczne przechowywanie, ponieważ każdy, kto go uzyska, może używać go do komunikacji z Meshy API w Twoim imieniu. Jeśli uważasz, że Twój klucz API został naruszony, możesz go w dowolnym momencie unieważnić z poziomu panelu, po unieważnieniu przestanie on być ważny.

Zgłaszanie problemów z bezpieczeństwem

Jeśli uważasz, że odkryłeś problem z bezpieczeństwem w Meshy API, skontaktuj się z nami. Doceniamy odpowiedzialne zgłaszanie takich problemów i dołożymy wszelkich starań, aby docenić Twój wkład.