IOPAY→Developers→Postman Starter
Narzędzia deweloperskie

Postman Starter

Kolekcja startowa do skonfigurowania danych uwierzytelniających, uwierzytelnienia w IOPAY i wykonania pierwszych requestów integracji.

FormatPostman Collection v2.1
AuthBearer
ZawieraLogin · Customer · PIX
Pobierz kolekcję ↓ Zmienne Base API →
Starter collection

Przegląd

Kolekcja porządkuje dane uwierzytelniające potrzebne do uwierzytelnienia w IOPAY, uzyskania access_token i użycia go jako Bearer token w kolejnych wywołaniach.

Uwierzytelnianie

POST /auth/login

Użyj swoich danych uwierzytelniających, aby uzyskać token dostępu do API.

Endpoint bazowy

base_url

Wartość początkowa ustawiona na https://api.iopay.com.br/api.

Import

Import

  1. Pobierz plik JSON z tej strony.
  2. W Postmanie użyj Import i wybierz kolekcję.
  3. Skonfiguruj auth_email, auth_secret i io_seller_id.
  4. Wykonaj request uwierzytelniający. access_token zostanie automatycznie zapisany w iopay_token.
  5. Utwórz customera. Zwrócone ID zostanie automatycznie zapisane w customer_id.
  6. Wykonaj request PIX z utworzonym customerem.
Zmienne

Zmienne

ZmiennaWartość początkowaZastosowanie
base_urlhttps://api.iopay.com.br/apiBaza wywołań.
auth_emailOkreślona przez CiebieE-mail używany do uwierzytelniania.
auth_secretOkreślona przez CiebieSecret używany do uwierzytelniania.
io_seller_idOkreślona przez CiebieIdentyfikator sellera używany w integracji.
iopay_tokenZwracana przez APIAccess token używany jako Bearer.
customer_idZwracana przez APIID utworzonego customera, zapisywane automatycznie przez kolekcję.
Pierwsze requesty

Uwierzytelnianie

Przed wykonaniem operacji uwierzytelnionych wyślij dane uwierzytelniające, aby uzyskać token dostępu.

POST {{base_url}}/auth/login
{
  "email": "{{auth_email}}",
  "secret": "{{auth_secret}}",
  "io_seller_id": "{{io_seller_id}}"
}

Odpowiedź

Access token
{
  "access_token": "<ACCESS_TOKEN>",
  "token_type": "bearer",
  "token_scope": "transaction",
  "expires_in": 3600
}
Bearer Token. Używaj wartości access_token jako Authorization: Bearer your_token w kolejnych wywołaniach.

Utwórz customera

Po skonfigurowaniu tokenu utwórz customera do użycia w transakcjach. Kolekcja automatycznie zapisuje zwrócony identyfikator w customer_id.

POST {{base_url}}/v1/customer/new
{
  "first_name": "Maria",
  "last_name": "Oliveira",
  "customer_type": "person_natural",
  "email": "[email protected]",
  "taxpayer_id": "12345678909",
  "phone_number": "+5511999999999",
  "address": {
    "line1": "Av. Paulista, 1000",
    "line2": "Apto 101",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01310100",
    "country_code": "BR"
  }
}
Automatycznie. Po utworzeniu kolekcja zapisuje success.id w customer_id, aby użyć go ponownie w kolejnych requestach.

Przykład z PIX

Po skonfigurowaniu tokenu możesz już wykonać transakcję PIX z istniejącym customerem.

POST {{base_url}}/v1/transaction/new/{{customer_id}}
{
  "amount": 24990,
  "currency": "BRL",
  "description": "Zamówienie #84217",
  "statement_descriptor": "IOPAY STORE",
  "io_seller_id": "{{io_seller_id}}",
  "payment_type": "pix",
  "reference_id": "pedido_84217"
}
Kwoty pieniężne. Pole amount należy wysyłać w centach. Na przykład 24990 oznacza R$ 249,90.
Rozwój

Zalecane użycie

  • Trzymaj prawdziwe dane uwierzytelniające i tokeny poza wersjonowanymi plikami.
  • Uzyskaj nowy token, gdy access_token wygaśnie.
  • Dodawaj requesty dla zasobów w miarę rozwoju integracji.
  • Dodaj automatyczne testy statusu i kluczowych pól.
  • Dokumentuj własne zmienne marketplace'u, sellera i Split.