Σχήμα αιτημάτων
Σχήμα αιτημάτων
Κάθε πεδίο των δύο αιτημάτων του API: τι σημαίνει, τι τιμές δέχεται και πότε χρειάζεται.
Δύο αιτήματα φτιάχνουν ένα παραστατικό: το παραστατικό και, όταν η πληρωμή γίνεται με κάρτα, η υπογραφή πληρωμής. Οι δύο σελίδες αυτής της ενότητας δείχνουν ένα προς ένα τα πεδία τους, με την ίδια δομή που έχουν μέσα στο JSON.
Πώς διαβάζονται
- Κάντε κλικ σε ένα πεδίο και ανοίγει. Μέσα βρίσκετε την περιγραφή του, πότε είναι υποχρεωτικό, πότε χρησιμοποιείται, τους περιορισμούς του, τις επιτρεπτές τιμές του και ένα παράδειγμα JSON με το πεδίο στη θέση του.
- Τα πεδία που είναι αντικείμενα ή πίνακες έχουν τα δικά τους πεδία μέσα τους, ένα επίπεδο πιο μέσα, πίσω από μια λεπτή γραμμή. Με τα κουμπιά Άνοιγμα όλων και Κλείσιμο όλων ανοίγουν και κλείνουν όλα μαζί.
- Δίπλα στο όνομα κάθε πεδίου υπάρχει ένα
#: είναι σύνδεσμος για το συγκεκριμένο πεδίο, οπότε μπορείτε να τον στείλετε σε κάποιον και να ανοίξει ακριβώς σε αυτό.
Οι σημάνσεις
- Υποχρεωτικό — το API απορρίπτει το αίτημα χωρίς αυτό.
- Υπό προϋπόθεση — χρειάζεται μόνο σε ορισμένες περιπτώσεις· ποιες είναι, το γράφει το πεδίο μέσα, στο «Πότε είναι υποχρεωτικό».
- Προαιρετικό — μπορείτε να το παραλείψετε.
- Δεν χρησιμοποιείται από το flexy — το πεδίο υπάρχει στο αίτημα και γίνεται δεκτό, αλλά η Flexy δεν το διαβάζει.
Οι δύο σελίδες
- Παραστατικό (
document) — το σώμα τουPOST /api/v1/documents/. - Υπογραφή πληρωμής (
signature) — το σώμα τουPOST /api/v1/signatures/.