Environnements
Nous offrons des environnements sandbox et production. Testez votre intégration dans le sandbox avant de passer en production.| Environnement | URL de base |
|---|---|
| Sandbox | https://api-sandbox.ship.uniuni.com/client/ |
| Production | https://api.ship.uniuni.com/prod/client/ |
Authentification
Chaque requête doit inclure votre jeton d’accès API dans l’en-têteAuthorization :
Format des requêtes et des réponses
- Toutes les requêtes et réponses utilisent le format JSON.
- Utilisez
Content-Type: application/json; charset=utf-8pour les corps de requêtes POST. - Toutes les clés d’objets sont en camelCase.
- Le code HTTP de réponse est toujours
200avec un contenu valide. Les contenus invalides retournent un code HTTP422.
| Champ | Type | Description |
|---|---|---|
message | string | Informations supplémentaires sur le statut de la requête |
code | integer | Code de statut (0 indique un succès) |
data | object | null | Contenu de la réponse. Retourne null si code n’est pas 0 |
Pagination
Les points de terminaison de collection prennent en charge la pagination via des paramètres de requête :| Paramètre | Par défaut | Max | Description |
|---|---|---|---|
page | 1 | — | Numéro de page |
pageSize | 10 | 500 | Résultats par page |
Tests en sandbox
Vous pouvez tester votre intégration librement en utilisant l’URL de base du sandbox. Aucun frais ne sera facturé. Les données du sandbox sont isolées et peuvent être réinitialisées sans affecter la production. Pour ajouter des crédits de test dans le sandbox, utilisez le numéro de carte de crédit de test 4242 4242 4242 4242 avec n’importe quelle date d’expiration et n’importe quel CVC.Gestion des erreurs
422 Contenu non traitable
Retourné lorsque des paramètres requis sont manquants ou ont un type incorrect :Erreurs d’authentification
Codes d’erreur
| Code | Raison |
|---|---|
0 | Succès |
1002 | Requête invalide |
1006 | Erreur de base de données |
1009 | Erreur générale |
1014 | Ressource introuvable (étiquettes/lots) |
1031 | Échec de la recherche de suivi |