Comprendere le basi della documentazione API Fairly Made®

Qui spiegheremo come è strutturata la nostra documentazione, quali informazioni contiene e come cercarle.

Ci sono articoli dedicati se sei interessato a come effettivamente inviare dati a noi tramite API, o come possiamo aiutarti con quel progetto, o a collegare i tuoi sistemi ai nostri.

La documentazione API - panoramica

Cominciamo con una panoramica:

La documentazione completa dell’API è disponibile a questo indirizzo.

Qui troverai tutto ciò che riguarda le API, con informazioni ordinate per tipo di progetto (l’offerta che hai scelto con Fairly Made) e poi per route (POST e GET).

Questa documentazione è realizzata per livelli di comprensione da intermedio ad esperto con spiegazioni dettagliate di ciascuna rotta e del loro contenuto.

Route POST

Per esempio, prendiamo la documentazione per il progetto STANDARD:

Esistono quattro route POST per creare un prodotto. I dati devono essere inviati in un ordine preciso (diverso dall'ordine alfabetico indicato nell'anteprima):

• SUPPLIER,
• PACKAGING (opzionale),
• PRODUCT
• e COMPONENT.

Campi richiesti

Ogni route ti indicherà i campi richiesti per creare ogni oggetto. Questi devono essere compilati, altrimenti riceverai un messaggio di errore e l'oggetto non sarà creato.

Esempio di Payload

E sulla destra ci sono i campioni di richiesta, per mostrarti come dovrebbe apparire un payload per questa route.

Prendi questa stessa route, il POST Create Component del tipo di progetto STANDARD:

È un esempio visivo dei parametri indicati a sinistra con dati casuali che puoi copiare e incollare per testare l’API.

Test POST - Create Component

{
"projectType": "STANDARD",
"componentRef": "Semelle Intérieure Cuir Y34",
"supplierComponentCode": "Soletta in pelle Y34",
"productCollectionRef": "SS26",
"productRef": "BottesMagnifiquesSS26",
"productColorCode": "NERO",
"type": "LEATHER",
"category": "INSOLES",
"composition": [
{
"material": "BOVINE LEATHER",
"percentage": 100
}
],
"componentWeight": 100,
"certifications": [
{
"date_start": "2024-02-04",
"type": "ICEC - LEATHER FROM ITALY - UNI EN 16484",
"date_end": "2024-12-04"
}
],
"importationBatch": "StandardPostV1Clotilde",
"supplierRef": "Tannerie Grandes Peaux"
}

Come spiegato nell'articolo precedente, l'ambiente Sandbox è progettato per testare l'invio di dati a Fairly Made. Appariranno messaggi di errore se mancano campi richiesti o se i dati sono errati. 

Route GET

Più in basso abbiamo le route GET, per interrogare l’API e ottenere i dati che desideri.

Proprio come le altre route, riceverai tutte le informazioni necessarie riguardanti questa, per esempio questo è il GET Study Details, con le informazioni richieste ancora in rosso, e troverai a destra il payload di esempio appropriato.

Risposte API

Ecco le risposte più comuni spiegate:

• 400: Risposta di Errore
  • 400: Richiesta non valida, ad esempio, componente già collegato
  • 403: Vietato, ad esempio, token errato utilizzato
  • 404: Punto di accesso inesistente, ad esempio, v2/supplierssss
• 200: Risposta di Validazione
  • 201: Validazione
• 500: Errore del server

Per una migliore comprensione dei possibili errori, consultare questo articolo.