{"_id":"59c07ea1a00f90001cd75cb5","category":{"_id":"59c07ea1a00f90001cd75cb2","version":"59c07ea1a00f90001cd75cb1","project":"56c27a9a2be66d19008d618d","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-16T01:25:47.579Z","from_sync":false,"order":0,"slug":"documentation","title":"Home"},"project":"56c27a9a2be66d19008d618d","user":"56c27a665da27c17003df001","parentDoc":null,"version":{"_id":"59c07ea1a00f90001cd75cb1","project":"56c27a9a2be66d19008d618d","__v":1,"createdAt":"2017-09-19T02:19:13.858Z","releaseDate":"2017-09-19T02:19:13.858Z","categories":["59c07ea1a00f90001cd75cb2","59c07ea1a00f90001cd75cb3"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Rose","version_clean":"5.1.0","version":"5.1"},"githubsync":"","__v":0,"updates":["56e8e2ca99c6400e00382107","56eb73751633510e00f884e1","56ebceb943304e2900e211b0"],"next":{"pages":[],"description":""},"createdAt":"2016-02-16T02:33:02.620Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"1. [Log in to your account](#1-log-in-to-your-account)\n2. [Register your application](#2-register-your-application)\n3. [Generate your API key](#3-generate-your-api-key)\n4. [Call the API](#4-call-the-api) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Log in to your account\"\n}\n[/block]\nLog in to your enterprise web portal (e.g., example.zyllem.com). \n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Both your enterprise **web portal address** and your **login credentials** are provided by your administrator. \"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/eeaea0c-login_to_your_zyllem_enterprise_web_portal.jpg\",\n        \"login to your zyllem enterprise web portal.jpg\",\n        1379,\n        648,\n        \"#c3bfb8\"\n      ],\n      \"caption\": \"\"\n    }\n  ]\n}\n[/block]\n   \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Register your application\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"\",\n  \"body\": \"**Application** is also referred to as **Client** in your enterprise web portal.\"\n}\n[/block]\n2.1 Go to **/Settings/API Clients**.\n2.2 Click **Add Client** to add your application.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d30dd6b-2017-09-19_16-25-38.gif\",\n        \"2017-09-19_16-25-38.gif\",\n        1258,\n        798,\n        \"#e7e8e9\"\n      ],\n      \"caption\": \"\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Don't see API Clients?\",\n  \"body\": \"Contact your administrator to grant you access to **API Clients**. If you can see **/Settings/Users** and **/Roles**, you can grant yourself access by <a href=\\\"https://help.zyllem.com/hc/en-us/articles/115001308113\\\" target=\\\"_blank\\\">adding and assigning a role</a> to your user account.\"\n}\n[/block]\n2.3 Fill in the application details and click **Save**.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/713aac5-Application_details.png\",\n        \"Application details.png\",\n        814,\n        326,\n        \"#f0efee\"\n      ],\n      \"caption\": \"\"\n    }\n  ]\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**Name** \",\n    \"0-1\": \"Your application name\",\n    \"1-0\": \"**Description** \",\n    \"1-1\": \"(Optional) Description of your application\",\n    \"2-0\": \"**Network** \",\n    \"2-1\": \"All orders booked via the API will reflect on this network. On the [Items page](https://help.zyllem.com/hc/en-us/articles/115009284248), this appears as **Ordered on Network:** *this network*\",\n    \"3-0\": \"**User** \",\n    \"3-1\": \"All orders booked via the API will reflect on this user. On the [Items page](https://help.zyllem.com/hc/en-us/articles/115009284248), this appears as **Ordered by:** *this user*\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\nOnce your application is added, it will be listed on the API CLIENTS TABLE.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9000eec-Application_added.png\",\n        \"Application added.png\",\n        1305,\n        392,\n        \"#f0f0ef\"\n      ],\n      \"caption\": \"\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"3. Generate your API key\"\n}\n[/block]\n3.1 Click on the application name you registered in [Step 2](#2-register-your-application).\n3.2 Under KEY TABLE SECTION, click **Add Key**. \n3.3 Fill in the key name and description (optional), and click **Save**.  \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2716a0e-generate_key2.gif\",\n        \"generate key2.gif\",\n        1244,\n        580,\n        \"#ededed\"\n      ],\n      \"caption\": \"\"\n    }\n  ]\n}\n[/block]\nOnce the key is generated, it will be listed on the KEY TABLE. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7393d9a-your_api_Key.jpg\",\n        \"your api Key.jpg\",\n        1184,\n        336,\n        \"#f3f2f2\"\n      ],\n      \"caption\": \"\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Using the API key\",\n  \"body\": \"The **API key** is used to authorize your connection to the Zyllem API. You need to attach it as a query parameter named `key` to all your calls to the API. You can generate multiple API keys and revoke them. See [Authorization 101](doc:authorization-101).\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"4. Call the API\"\n}\n[/block]\nTest the integration by using [/ping endpoint](ping).\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"Once you get a successful ping response, you are ready to book your first delivery order.\",\n  \"title\": \"\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\"\n}\n[/block]\n##:fa-life-ring:  [Ask a question](https://developer.zyllem.com/discuss)","excerpt":"A quick guide to get your first integration running","slug":"getting-started","type":"basic","title":"Getting Started"}

Getting Started

A quick guide to get your first integration running

1. [Log in to your account](#1-log-in-to-your-account) 2. [Register your application](#2-register-your-application) 3. [Generate your API key](#3-generate-your-api-key) 4. [Call the API](#4-call-the-api) [block:api-header] { "type": "basic", "title": "1. Log in to your account" } [/block] Log in to your enterprise web portal (e.g., example.zyllem.com). [block:callout] { "type": "info", "body": "Both your enterprise **web portal address** and your **login credentials** are provided by your administrator. " } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/eeaea0c-login_to_your_zyllem_enterprise_web_portal.jpg", "login to your zyllem enterprise web portal.jpg", 1379, 648, "#c3bfb8" ], "caption": "" } ] } [/block] [block:api-header] { "type": "basic", "title": "2. Register your application" } [/block] [block:callout] { "type": "info", "title": "", "body": "**Application** is also referred to as **Client** in your enterprise web portal." } [/block] 2.1 Go to **/Settings/API Clients**. 2.2 Click **Add Client** to add your application. [block:image] { "images": [ { "image": [ "https://files.readme.io/d30dd6b-2017-09-19_16-25-38.gif", "2017-09-19_16-25-38.gif", 1258, 798, "#e7e8e9" ], "caption": "" } ] } [/block] [block:callout] { "type": "warning", "title": "Don't see API Clients?", "body": "Contact your administrator to grant you access to **API Clients**. If you can see **/Settings/Users** and **/Roles**, you can grant yourself access by <a href=\"https://help.zyllem.com/hc/en-us/articles/115001308113\" target=\"_blank\">adding and assigning a role</a> to your user account." } [/block] 2.3 Fill in the application details and click **Save**. [block:image] { "images": [ { "image": [ "https://files.readme.io/713aac5-Application_details.png", "Application details.png", 814, 326, "#f0efee" ], "caption": "" } ] } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "**Name** ", "0-1": "Your application name", "1-0": "**Description** ", "1-1": "(Optional) Description of your application", "2-0": "**Network** ", "2-1": "All orders booked via the API will reflect on this network. On the [Items page](https://help.zyllem.com/hc/en-us/articles/115009284248), this appears as **Ordered on Network:** *this network*", "3-0": "**User** ", "3-1": "All orders booked via the API will reflect on this user. On the [Items page](https://help.zyllem.com/hc/en-us/articles/115009284248), this appears as **Ordered by:** *this user*" }, "cols": 2, "rows": 4 } [/block] Once your application is added, it will be listed on the API CLIENTS TABLE. [block:image] { "images": [ { "image": [ "https://files.readme.io/9000eec-Application_added.png", "Application added.png", 1305, 392, "#f0f0ef" ], "caption": "" } ] } [/block] [block:api-header] { "title": "3. Generate your API key" } [/block] 3.1 Click on the application name you registered in [Step 2](#2-register-your-application). 3.2 Under KEY TABLE SECTION, click **Add Key**. 3.3 Fill in the key name and description (optional), and click **Save**. [block:image] { "images": [ { "image": [ "https://files.readme.io/2716a0e-generate_key2.gif", "generate key2.gif", 1244, 580, "#ededed" ], "caption": "" } ] } [/block] Once the key is generated, it will be listed on the KEY TABLE. [block:image] { "images": [ { "image": [ "https://files.readme.io/7393d9a-your_api_Key.jpg", "your api Key.jpg", 1184, 336, "#f3f2f2" ], "caption": "" } ] } [/block] [block:callout] { "type": "info", "title": "Using the API key", "body": "The **API key** is used to authorize your connection to the Zyllem API. You need to attach it as a query parameter named `key` to all your calls to the API. You can generate multiple API keys and revoke them. See [Authorization 101](doc:authorization-101)." } [/block] [block:api-header] { "type": "basic", "title": "4. Call the API" } [/block] Test the integration by using [/ping endpoint](ping). [block:callout] { "type": "success", "body": "Once you get a successful ping response, you are ready to book your first delivery order.", "title": "" } [/block] [block:api-header] { "type": "basic" } [/block] ##:fa-life-ring: [Ask a question](https://developer.zyllem.com/discuss)