Prise en main
Pour commencer à utiliser nos API, vous devez :
  • Créer un compte développeur
  • Créer une application à l’intérieur du module développeur
  • Demander votre clé API
  • Envoyer votre première requête API

Créer un compte développeur

Rendez-vous à « Inscription à un compte développeur » et remplissez le formulaire pour créer votre compte. Le compte développeur est un compte d’essai qui vous donnera l’accès immédiat à quatre établissements afin que vous puissiez commencer à manipuler nos API. Les activités menées dans un compte développeur n’auront aucun effet sur la production. Vous devez être abonné à Yext pour avoir accès aux terminaux PowerListings®, Analytics, Reviews, Social, et User. Pour plus de renseignements sur l’inscription, visitez notre site Web.
CLIENTS ET PARTENAIRES DE YEXT Si vous utilisez déjà nos API, vous n’avez pas besoin de créer un compte développeur; vous pouvez vous connecter en utilisant le nom d’utilisateur et le mot de passe que vous utilisez déjà.

Créer une application à l’intérieur du module développeur

  1. Connectez-vous à votre compte développeur ou à votre compte Yext.
  2. Entrez dans le module développeur en pointant votre curseur sur votre nom, dans la partie droite du haut de la page, et en sélectionnant « Module développeur ».
  3. Dans le module développeur, cliquez sur « + Nouvelle application ».
  4. Entrez les renseignements demandés puis cliquez sur « Créer une application ».

Demander votre clé API

Une fois votre application créée, accédez-y dans la section « Vos applications » du module développeur. La clé API de l’application devrait apparaître sous son nom. Copiez la clé API et conservez-la quelque part où vous pourrez la retrouver facilement une fois à l’étape suivante.

Envoyer votre première requête API

Ouvrez votre navigateur Web et rendez-vous à l’URL suivant :

GET https://api.yext.com/v2/accounts/me/locations?api_key=VOTRE_CLÉ_API&v=AAAAMMJJ

où :
  • VOTRE_CLÉ_API désigne la clé API de votre application, et
  • AAAAMMJJ désigne la date d’aujourd’hui.
La réponse API obtenue devrait être une liste de quatre établissements, soit un pour chaque bureau de Yext :
{
    "meta": {
        "errors": [],
        "uuid": "f1128-b4ef-4803-a47a-3fd70"
    },
    "response": {
        "count": 4,
        "locations": [
            {
                "accountId": "1206158",
                "address": "7900 Westpark Drive",
                "address2": "Suite T200",
                "categoryIds": [
                    "668"
                ],
                "city": "McLean",
                "countryCode": "US",
                "description": "Yext is the global digital knowledge management leader, and our Knowledge Engine puts businesses in control of their digital knowledge.",
                "featuredMessage": "Call Today",
                "folderId": "0",
                "id": "3686765",
                "isPhoneTracked": false,
                "language": "en",
                "localPhone": "6467624579",
                "locationName": "Yext",
                "locationType": "LOCATION",
                "phone": "8884442988",
                "state": "VA",
                "suppressAddress": false,
                "timestamp": 1475605507908,
                "websiteUrl": "https://locations.yext.com/us/va/mclean/7900-westpark-drive.html",
                "zip": "22102"
            },
            {
                "accountId": "1206158",
                "address": "48 Warwick St.",
                "address2": "Office 410",
                "categoryIds": [
                    "668"
                ],
                "city": "London",
                "countryCode": "GB",
                "description": "Yext is the global digital knowledge management leader, and our Knowledge Engine puts businesses in control of their digital knowledge.",
                "featuredMessage": "Call Today",
                "folderId": "0",
                "id": "3686766",
                "isPhoneTracked": false,
                "language": "en",
                "locationName": "Yext",
                "locationType": "LOCATION",
                "phone": "2037052290",
                "state": "Gt Lon",
                "suppressAddress": false,
                "timestamp": 1475605508191,
                "websiteUrl": "https://locations.yext.com/gb/gt-lon/london/48-warwick-st-.html",
                "zip": "W1B 5AW"
            },
            {
                "accountId": "1206158",
                "address": "500 West Madison St.",
                "address2": "Suite 2810",
                "categoryIds": [
                    "668"
                ],
                "city": "Chicago",
                "countryCode": "US",
                "description": "Yext is the global digital knowledge management leader, and our Knowledge Engine puts businesses in control of their digital knowledge.",
                "featuredMessage": "Call Today",
                "folderId": "0",
                "id": "3686767",
                "isPhoneTracked": false,
                "language": "en",
                "locationName": "Yext",
                "locationType": "LOCATION",
                "phone": "2129943900",
                "state": "IL",
                "suppressAddress": false,
                "timestamp": 1475605508686,
                "websiteUrl": "https://locations.yext.com/us/il/chicago/500-west-madison-st-.html",
                "zip": "60661"
            },
            {
                "accountId": "1206158",
                "address": "1 Madison Ave",
                "address2": "5th Floor",
                "categoryIds": [
                    "668"
                ],
                "city": "New York",
                "countryCode": "US",
                "description": "Yext is the global digital knowledge management leader, and our Knowledge Engine puts businesses in control of their digital knowledge.",
                "featuredMessage": "Call Today",
                "folderId": "0",
                "id": "3686768",
                "isPhoneTracked": false,
                "language": "en",
                "localPhone": "2128136543",
                "locationName": "Yext",
                "locationType": "LOCATION",
                "phone": "8884442988",
                "state": "NY",
                "suppressAddress": false,
                "timestamp": 1475605509124,
                "websiteUrl": "https://locations.yext.com/us/ny/new-york/1-madison-ave.html",
                "zip": "10010"
            }
        ]
    }
}
Vous avez terminé votre première requête API avec succès.

Étapes suivantes

Pour en apprendre davantage sur tout ce que vous pouvez faire avec l’API de Knowledge, jetez un œil aux ressources suivantes :