DocsUwierzytelnianie
Dowiedz się, jak uwierzytelniać się w API Cost+
Cała komunikacja z API Cost+ wymaga TLS 1.2 lub nowszego oraz uwierzytelniania HTTP Basic.
Jak działa Basic Auth
Uwierzytelniaj się, używając klucza API jako nazwy użytkownika z pustym hasłem. Zakoduj w Base64 ciąg \{api_key\}: (zwróć uwagę na końcowy dwukropek — hasło jest puste).
Wynikowy nagłówek Authorization wygląda następująco:
Authorization: Basic aHVudGVyMjo=Nigdy nie ujawniaj swojego klucza API w kodzie po stronie klienta ani w publicznych repozytoriach. Przechowuj go wyłącznie po stronie serwera.
Użycie cURL
Gotowe rozwiązanie (zalecane)
cURL natywnie obsługuje Basic Auth za pomocą flagi -u. Przekaż swój klucz API, a po nim dwukropek:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Ręczne kodowanie Base64
Jeśli wolisz samodzielnie skonstruować nagłówek, najpierw zakoduj klucz:
echo -n "YOUR_API_KEY:" | base64Następnie przekaż zakodowaną wartość w nagłówku Authorization:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Końcowy dwukropek po kluczu API jest wymagany — oddziela on nazwę użytkownika od (pustego) hasła w schemacie Basic Auth.
Kody statusu HTTP
API używa standardowych kodów statusu HTTP do wskazywania wyniku żądania.
| Kod statusu | Znaczenie | Opis |
|---|---|---|
| 200 | OK | Żądanie zakończone sukcesem. |
| 201 | Utworzono | Zasób został pomyślnie utworzony. |
| 400 | Nieprawidłowe żądanie | Żądanie było niepoprawne lub brakowało wymaganych pól. |
| 401 | Brak autoryzacji | Uwierzytelnianie nie powiodło się — sprawdź swój klucz API. |
| 403 | Zabronione | Nie masz uprawnień do dostępu do tego zasobu. |
| 404 | Nie znaleziono | Żądany zasób nie istnieje. |
| 500 | Wewnętrzny błąd serwera | Coś poszło nie tak po naszej stronie. |
| 502 | Błąd bramy | Błąd usługi nadrzędnej. |
| 503 | Usługa niedostępna | API jest tymczasowo niedostępne. |
| 504 | Przekroczono limit czasu bramy | Usługa nadrzędna nie odpowiedziała na czas. |