> For the complete documentation index, see [llms.txt](https://docs.innopaas.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.innopaas.com/api-reference/api-reference-en/overview/innopaas-api-getting-started-guide.md).

# InnoPaaS API Getting Started Guide

## Interface Signature Verification Instructions

### Common Request Headers

To ensure interface security, all interfaces need to include a security verification request header,

Among them, Authorization and AppKey can be obtained only after creating an AppKey on the InnoPaaS platform

Used for interface authentication verification; if verification fails, the interface cannot be called and an authentication failure will be returned.

<table data-header-hidden><thead><tr><th width="97.7890625"></th><th width="142.16796875"></th><th width="111.828125"></th><th width="133.48046875"></th><th></th></tr></thead><tbody><tr><td>No.</td><td>Field</td><td>Data Type</td><td>Required</td><td>Description</td></tr><tr><td>1</td><td>Content-Type</td><td>String</td><td>Yes</td><td>The value is "application/json;charset=utf-8", and the request content is JSON</td></tr><tr><td>2</td><td>AppKey</td><td>String</td><td>Yes</td><td>ApiKey, application access KEY</td></tr><tr><td>3</td><td>Authorization</td><td>String</td><td>Yes</td><td>Authorization Token for application access</td></tr></tbody></table>

**Sample code for Headers**

```python
headers = {
   'Authorization': 'YUIYIUIAIIASUDIAOSIDUOIWUOQWUEOIUWOEUQWOEUOQWUOUWOUWQOWU',
   'AppKey': 'XFbZY1rtTKo3UD4n1'
   }
```

### Get AppKey

**Create application**

<figure><img src="https://170531697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FCztyKgpQWgCYr5yoMOIF%2Fimage.png?alt=media&amp;token=78b13c4a-987e-4dd0-b08d-b6fb6782c457" alt=""><figcaption></figcaption></figure>

**Copy AppKey:**&#x43;lick the \[Copy] button in the application list to copy the AppKey

<figure><img src="https://170531697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FdDXvlFRivYZ5x47MoOnd%2Fimage.png?alt=media&amp;token=b0320a68-5527-4e8d-8ef0-49fa75074aab" alt=""><figcaption></figcaption></figure>

### Get Authorization

1\. Select an application and click the \[Token] button to generate the Authorization information needed for the production app to access the interface,**We will not store the customer's Token information. Each time a new one is generated, the previously generated Token will become invalid. If the Token of this App has already been used in your production environment, please use this feature with caution. The invalidation of the original Token may cause the API to become inaccessible normally.**

<figure><img src="https://170531697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2Fx3aIULiWOaQsp4HP99q7%2Fimage.png?alt=media&amp;token=045e1db0-eb29-4ff6-83bd-bdfa357fb406" alt=""><figcaption></figcaption></figure>

2\. Generate and copy the Token

* Select the Token expiration time. The default is never expire, or you can specify an expiration date. &#x20;
* Click the \[Create Access Token] button to generate the Token &#x20;
* Click the \[Copy] button to copy the Token

<figure><img src="https://170531697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FkFQSLeqOBzgsQLzQxqSn%2Fimage.png?alt=media&amp;token=d849f6bc-c62d-4c81-a012-02c6f81e2750" alt=""><figcaption></figcaption></figure>

## Configure WebHook callback address

### Configure WebHook events

&#x20; **When sending push templates, upstream reply messages, and other events, if the App cannot be identified or matched, the data will be pushed to the default application. If there is no default application at this time, it will not be pushed.** &#x20;

1\. In the API Keys function menu list, click the callback event configuration button to start configuring

<figure><img src="https://170531697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FPjpLX7HMHkVCFf7ZPDBB%2Fimage.png?alt=media&amp;token=62d6237f-6c33-4f41-9513-9379d937ada1" alt=""><figcaption></figcaption></figure>

2\. Click the \[Add] button to add

<figure><img src="https://170531697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FInAgUHn1d2I3jvZRvPzp%2Fimage.png?alt=media&amp;token=e2baafe5-3b10-42fa-9384-40e9158a0d34" alt=""><figcaption></figcaption></figure>

3\. Select the product for which you need to configure the WebHook from the available product list

<figure><img src="https://170531697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FCqgUPRWrJNhz51S43VTk%2Fimage.png?alt=media&amp;token=5d387c4e-b5af-4082-8dde-3ca48ca34b75" alt=""><figcaption></figcaption></figure>

4\. Configure the callback address, select the events you want to receive, and click Next to proceed to the next step

<figure><img src="https://170531697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FdIkB7qagt3c1A6PwtRpw%2Fimage.png?alt=media&amp;token=5dbb39f3-1d74-44ce-a29b-42991acf5b39" alt=""><figcaption></figcaption></figure>

5\. Select the callback request method. The default is POST. If the customer's business system needs to verify the source of the Webhook, you can configure the UserName and Authorization header information. When the WebHook notification is pushed, the UserName and Authorization will be added to the header information and the configured information will be pushed to the customer's system togethe&#x72;**.**

<figure><img src="https://170531697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FzGKPXZQ4bM9Ja4AFDlyM%2Fimage.png?alt=media&amp;token=52655978-16a4-43e1-bedb-c67430fb4def" alt=""><figcaption></figcaption></figure>
