IOPAY→Developers→Postman Starter
Entwicklungswerkzeuge

Postman Starter

Einstiegs-Collection, um Ihre Zugangsdaten einzurichten, sich bei IOPAY zu authentifizieren und die ersten Requests der Integration auszuführen.

FormatPostman Collection v2.1
AuthBearer
EnthältLogin · Customer · PIX
Collection herunterladen ↓ Variablen Basis-API →
Starter collection

Überblick

Die Collection ordnet die Zugangsdaten, die zur Authentifizierung bei IOPAY nötig sind, um ein access_token zu erhalten und es als Bearer Token in den folgenden Aufrufen zu verwenden.

Authentifizierung

POST /auth/login

Verwenden Sie Ihre Zugangsdaten, um das Zugriffstoken der API zu erhalten.

Basis-Endpunkt

base_url

Anfangswert gesetzt auf https://api.iopay.com.br/api.

Import

Import

  1. Laden Sie die JSON-Datei dieser Seite herunter.
  2. Verwenden Sie in Postman Import und wählen Sie die Collection aus.
  3. Konfigurieren Sie auth_email, auth_secret und io_seller_id.
  4. Führen Sie den Authentifizierungs-Request aus. Das access_token wird automatisch in iopay_token gespeichert.
  5. Legen Sie einen Customer an. Die zurückgegebene ID wird automatisch in customer_id gespeichert.
  6. Führen Sie den PIX-Request mit dem angelegten Customer aus.
Variablen

Variablen

VariableAnfangswertVerwendung
base_urlhttps://api.iopay.com.br/apiBasis der Aufrufe.
auth_emailVon Ihnen festgelegtFür die Authentifizierung verwendete E-Mail.
auth_secretVon Ihnen festgelegtFür die Authentifizierung verwendetes Secret.
io_seller_idVon Ihnen festgelegtIn der Integration verwendete Seller-Kennung.
iopay_tokenVon der API zurückgegebenAls Bearer verwendetes Access Token.
customer_idVon der API zurückgegebenID des angelegten Customers, automatisch von der Collection gespeichert.
Erste Requests

Authentifizierung

Senden Sie vor authentifizierten Vorgängen Ihre Zugangsdaten, um das Zugriffstoken zu erhalten.

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

Rückgabe

Access Token
{
  "access_token": "<ACCESS_TOKEN>",
  "token_type": "bearer",
  "token_scope": "transaction",
  "expires_in": 3600
}
Bearer Token. Verwenden Sie den Wert von access_token als Authorization: Bearer your_token in den folgenden Aufrufen.

Customer anlegen

Legen Sie mit eingerichtetem Token einen Customer für die Transaktionen an. Die Collection speichert die zurückgegebene Kennung automatisch in 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"
  }
}
Automatisch. Nach dem Anlegen speichert die Collection success.id in customer_id, um es in den nächsten Requests wiederzuverwenden.

Beispiel mit PIX

Mit eingerichtetem Token können Sie bereits eine PIX-Transaktion mit einem bestehenden Customer ausführen.

POST {{base_url}}/v1/transaction/new/{{customer_id}}
{
  "amount": 24990,
  "currency": "BRL",
  "description": "Bestellung #84217",
  "statement_descriptor": "IOPAY STORE",
  "io_seller_id": "{{io_seller_id}}",
  "payment_type": "pix",
  "reference_id": "pedido_84217"
}
Geldbeträge. Das Feld amount muss in Cent gesendet werden. Beispielsweise steht 24990 für R$ 249.90.
Weiterentwicklung

Empfohlene Nutzung

  • Halten Sie echte Zugangsdaten und Tokens aus versionierten Dateien heraus.
  • Holen Sie ein neues Token, wenn das access_token abläuft.
  • Fügen Sie Requests pro Ressource hinzu, während sich die Integration weiterentwickelt.
  • Ergänzen Sie automatische Tests für Status und wesentliche Felder.
  • Dokumentieren Sie eigene Variablen für Marketplace, Seller und Split.