Accéder aux données

Take it easy !

Comment ça fonctionne

Toutes les informations sont retournées au format JSON et accessibles par un appel d'URL correspondante.
La clé doit être passée en paramètre à chaque requête.
Chaque réponse fournie est construite sur le même schéma : un booleen pour vérifier le succès de la requête, un message en cas d'erreur puis enfin les données.
En prévision des futures versions de l'API et pour éviter tout problème à l'avenir, nous vous conseillons de passer un paramètre afin de spécifier que vous utilisez la v1.

Infos entreprise

https://api.striveweb.com/companies/{idCompany}?key={apiKey}&v=1.0

Renvoie les infos sur une entreprise : nom, lien, description, siret, infos diverses, catégories de produits et horaires d'ouverture.

array(
    'success' => true,
    'message' => 'an error message if necessary',
    'data' => array(
        'id' => 1,
        'username' => 'theUsername',
        'permaLink' => 'a link to the striveweb page',
        'picture' => 'a link to the profile picture',
        'designation' => 'the name of the company',
        'shortDescription' => 'a short description of the company',
        'description' => 'a longer description of the company',
        'tel' => '01 02 03 04 05',
        'webSite' => 'http://proximatom.com',
        'siret' => '101 010 101 11100',
        'location' => array(
            'address' => '2 Place François Rude',
            'postalCode' => '37200',
            'city' => 'Tours',
            'lat' => 47.3666276,
            'lng' => 0.7055497000000059,
        ),
        'productCategories' => array(
            [0] => array(
                'id' => 12,
                'designation' => 'first category',
                'slug' => 'first-category',
                'description' => 'first description',
                'randomPicture' => 'a link for an image',
            ),
            [1] => array(
                'id' => 27,
                'description' => 'another category',
                'slug' => 'another-category',
                'description' => 'another description for another category',
                'randomPicture' => 'a link for an image',
            ),
            [...]
        ),
        //les horaires d'ouverture
        'openingTimes' => array(
            //la clé correspond au jour de la semaine, commençant par dimanche
            [0] => array(
                [0] => array(
                    'begin' => '9:00',
                    'end' => '12:00',
                ),
                [1] => array(
                    'begin' => '13:00',
                    'end' => '17:00',
                ),
            ),
            [1] => array(
                [0] => array(
                    'begin' => '9:00',
                    'end' => '12:00',
                ),
                [1] => array(
                    'begin' => '13:00',
                    'end' => '17:00',
                ),
            ),
            [...]
        ),
    ),
);
                

Catégorie de produits

https://api.striveweb.com/productCategories/{idCategory}?key={apiKey}&v=1.0

Récupère les informations sur une catégorie de produits, ainsi que les distributions qui la composent

array(
    'success' => true,
    'message' => 'an error message if necessary',
    'data' => array(
        'id' => 92,
        'designation' => 'the name of the category',
        'slug' => 'the-name-of-the-category',
        'description' => 'a description of the category',
        'productDistributions' => array(
            [0] => array(
                'id' => 55,
                'price' => 14.90,
                'typeOfPricing' => array(
                    'id' => 2,
                    'text' => '/kg'
                'product' => array(
                    'id' => 23,
                    'designation' => 'the name of the product',
                    'slug' => 'the-name-of-the-product',
                    'description' => 'this is a wonderful product',
                    'picture' => 'a link to an image',
                )
            ),
            [1] => array(
                'id' => 57,
                'price' => 15.10,
                'typeOfPricing' => array(
                    'id' => 3,
                    'text' => '/l'
                'product' => array(
                    'id' => 23,
                    'designation' => 'the name of the second product',
                    'slug' => 'the-name-of-the-second-product',
                    'description' => 'this is another wonderful product',
                    'picture' => 'a link to an image',
            ),
            [...]
        ),
    ),
);
                

Distribution de produit

https://api.striveweb.com/productDistributions/{idDistribution}?key={apiKey}&v=1.0

array(
    'success' => true,
    'message' => 'an error message if necessary',
    'data' => array(
        'id' => 55,
        'product' => array(
            'id' => 23,
            'designation' => 'the name of the product',
            'slug' => 'the-name-of-the-product',
            'description' => 'this is a wonderful product',
            'longDescription' => 'this is a wonderful product, because we use the best components [...]',
            'photo' => 'a link to an image',
        ),
        'productCategory' => array(
            'id' => 27,
            'designation' => 'a product category',
            'slug' => 'a-product-category',
        ),
        'price' => 14.90,
        'typeOfPricing' => array(
            'id' => 2,
            'text' => '/kg'
    ),
);