Conventions de nommage des SDKs
Ce que les SDKs renomment, ce qu'ils conservent et où se situe la limite.
Dans les SDKs serveur, les noms de méthodes suivent les conventions de votre langage, et les noms
de champs gardent le snake_case de l'API : created_at, authorization_url, per_page.
Ce qui change et ce qui ne change pas
| Couche | Suit les conventions du langage | Exemple |
|---|---|---|
| Noms des clients, ressources et méthodes | Oui | wajub.payments.listRefunds(), client.Payments.ListRefunds() |
| Champs envoyés | Non | "authorization_url", "per_page", "decline_code" |
| Champs reçus | Non | payment.authorization_url, payment["created_at"] |
| Chemins HTTP et paramètres d'URL | Non | /webhooks, ?per_page=50 |
| Noms des en-têtes | Non | Idempotency-Key, X-Wajub-Signature |
| Valeurs d'énumération | Non | payment.succeeded, pending, XAF |
| Identifiants de ressources | Non | trx_…, cus_…, po_… |
"authorization_url": "https://pay.wajub.com/test_xxxxx"En Ruby, utilisez payment.authorization_url, en Java payment.getAuthorizationUrl() et en C#
payment.AuthorizationUrl. En Go, Java et C#, lisez-le dans ce champ typé :
Raw["authorization_url"] ne trouve rien.
Noms de méthodes par langage
| SDK | Style | Exemple de méthode |
|---|---|---|
| Node.js | camelCase | wajub.webhookEndpoints.rotateSecret() |
| Python | snake_case | wajub.webhook_endpoints.rotate_secret() |
| PHP | camelCase | $wajub->webhookEndpoints->rotateSecret() |
| Go | PascalCase | client.WebhookEndpoints.RotateSecret() |
| Ruby | snake_case | client.webhook_endpoints.rotate_secret |
| Java | camelCase | client.webhookEndpoints().rotateSecret() |
| C# | PascalCase avec Async | client.WebhookEndpoints.RotateSecretAsync() |
En Python, l'accesseur global s'écrit wajub.global_, car global est un mot-clé.
Créez un paiement avec payments.create.
Les langages typés décodent quelques champs
Go, Java et C# exposent les champs principaux d'un paiement en champs typés, nommés selon le
langage, et tous les autres champs dans Raw, sous leur nom d'API.
payment.id
payment.status
payment.amount
payment.currency
payment.authorization_url
payment.authorization_token
payment.reference // an index signature covers the restLire la référence API depuis n'importe quel SDK
La référence documente le format d'échange. Appliquez exactement une transformation.
| Dans la référence | Dans votre code |
|---|---|
POST /webhooks/{id}/rotate-secret | La méthode, selon les conventions de votre langage |
authorization_url dans le corps de la réponse | La même chaîne, inchangée |
per_page comme paramètre d'URL | La même chaîne, inchangée |
Sans SDK, tout utilise le snake_case
Un appel HTTP brut envoie et reçoit du snake_case dans les corps JSON et les paramètres d'URL.
Aucun endpoint n'accepte le camelCase.
Pages associées
- SDKsTous les packages et leur environnement.
- Démarrage rapide des SDKsLe même premier appel dans cinq langages présentés côte à côte.
- ErreursL'enveloppe d'erreur et tous les codes de statut.
- PaginationLa structure de liste qu'enveloppe chaque SDK.
- Vérification de signatureLes noms d'en-têtes, qui ne changent jamais.