Ξεκινώντας

Τι είναι το CRM API

Το CRM API είναι ένα HTTP API με απαντήσεις σε μορφή JSON. Μέσω αυτού, ένα εξωτερικό σύστημα εργάζεται με τα ίδια δεδομένα όπως και το CRM FoodSoul: διαβάζει, δημιουργεί και τροποποιεί τα δεδομένα εκ μέρους του λογαριασμού.

Όλα τα αιτήματα αποστέλλονται μέσω HTTPS στη διεύθυνση https://foodsoul.ru/api/crm/v2.

Ο οδηγός API περιγράφει κάθε μέθοδο: παραμέτρους, σώμα αιτήματος, απαντήσεις και παραδείγματα σε curl, PHP, JavaScript και Python. Η πλήρης περιγραφή του API μπορεί να ληφθεί σε μορφή OpenAPI και να συνδεθεί στο Postman, το Insomnia ή σε γεννήτρια SDK.

Πώς να αποκτήσετε ένα API token

Τα αιτήματα ενσωμάτωσης εξουσιοδοτούνται με API token. Το token εκδίδεται από τον κάτοχο ή τον διαχειριστή του λογαριασμού στο CRM, στην ενότητα «API tokens».

1. Ανοίξτε στην CRM την ενότητα «API tokens» και δημιουργήστε ένα token.
2. Επιλέξτε ρόλο για το διακριτικό: από αυτήν εξαρτώνται οι διαθέσιμες μέθοδοι. Ο ρόλος του εκδοθέντος διακριτικού δεν μπορεί να αλλάξει.
3. Για να λειτουργεί το διακριτικό μόνο με ένα δίκτυο, επιλέξτε το. Χωρίς επιλογή δικτύου, το διακριτικό έχει πρόσβαση σε όλα τα δίκτυα του λογαριασμού και τα αιτήματα μεταφέρουν το δίκτυο στην κεφαλίδα chain.
4. Εάν είναι απαραίτητο, ορίστε τη διάρκεια ισχύος του token και τις επιτρεπόμενες διευθύνσεις IP.
5. Αντιγράψτε το διακριτικό αμέσως μετά τη δημιουργία: η ανοιχτή τιμή εμφανίζεται μόνο μία φορά και δεν μπορεί να ανακτηθεί ξανά.

Το διακριτικό ξεκινά με fs_api_ και μεταδίδεται στην κεφαλίδα Authorization: Bearer <διακριτικό>. Το διακριτικό αποθηκεύεται όπως ο κωδικός πρόσβασης: μην το δημοσιεύετε στον κώδικα ιστοσελίδων ή εφαρμογών για κινητά και μην το διαβιβάζετε σε τρίτους. Εάν το διακριτικό χαθεί, να το μπλοκάρετε ή να το διαγράψετε στην ίδια ενότητα του CRM.

Πρώτο αίτημα

Ελέγξτε το διακριτικό με το αίτημα «Λήψη δεδομένων χρήστη». Αντικαταστήστε το fs_api_YOUR_TOKEN με το δικό σας διακριτικό.

Εκτός από το διακριτικό, κάθε αίτημα μεταδίδει τις κεφαλίδες role — ρόλος, για αυτό το API partner, και language — γλώσσα των κειμένων στην απάντηση, για παράδειγμα el.

curl -X GET 'https://foodsoul.ru/api/crm/v2/application.user_info' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: el' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/application.user_info', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'el',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/application.user_info", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "el",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.ru/api/crm/v2/application.user_info",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "el",
        "role": "partner",
    },
)
data = response.json()

Επιτυχής απάντηση — HTTP 200 και JSON με status: success, τα δεδομένα βρίσκονται στο πεδίο data. Σε περίπτωση σφάλματος, το status είναι error, ενώ ο κωδικός και το μήνυμα του σφάλματος βρίσκονται στο πεδίο error.

Περιγραφή μεθόδου: Λήψη δεδομένων χρήστη →

Τι ακολουθεί

• Αναφορά API — όλες οι μέθοδοι με παραμέτρους, απαντήσεις και παραδείγματα αιτημάτων
• Εξουσιοδότηση — τίτλοι εξουσιοδότησης και σύνολα που δέχονται μεθόδους
• Webhooks — ειδοποιήσεις για συμβάντα στη διεύθυνση του συστήματός σας
• Σφάλματα — κωδικοί σφαλμάτων και οι σημασίες τους
• Αλλαγές — τι άλλαξε στο API
• Λήψη OpenAPI · YAML