tracer
/
bindAPI
3
0
Fork 0
Code Issues 2 Pull Requests Projects Releases 15 Wiki Activity

moved API section to the bottom 

Signed-off-by: tracer <tracer@24unix.net>
This commit is contained in:
tracer 2022-02-20 20:14:14 +01:00
parent 86b12af2e2
commit 6e106dbc2c
1 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@ -45,38 +45,7 @@ The CLI is used to perform configuration and some checks:
The APi is a RESTful API, there is a self explaining Swagger/OpenAPI available. The APi is a RESTful API, there is a self explaining Swagger/OpenAPI available.
On the site you can authorize with an API key (creation of the key is described later in this document).
![Authorize](https://bindapi.24unix.net/assets/bindAPI_api2.png)
And enter you API key:
![Enter Apikey](https://bindapi.24unix.net/assets/bindAPI_api3.png)
After successful authorization you can use the APi via the OpenAPI Interface, e.g. call the /ping endpoint to check if the API is alive.
You have to click on „Try it out“:
![Try it out](https://bindapi.24unix.net/assets/bindAPI_api4.png)
And then hit Execute:
![Try it out](https://bindapi.24unix.net/assets/bindAPI_api5.png)
Of course, you can issue the same command in your shell:
`
curl -X 'GET' \
'https://ns1.24unix.net/api/ping' \
-H 'accept: application/json' \
-H 'X-API-Key: 61f27a57c9d1f.[truncated]'
`
A helpful tool when dealing with API is [Postman](https://https://www.postman.com/), if offers the same options as from the OpenAPI interface or via shell with curl.
![Php Interpreter](https://bindapi.24unix.net/assets/bindAPI_api6.png)
<a name="installation"></a> <a name="installation"></a>
# 3. Installation # 3. Installation
@ -321,7 +290,38 @@ Now we can finally begin to populate our configuration:
<a name="theapi"></a> <a name="theapi"></a>
# 5. The API # 5. The API
On the site you can authorize with an API key (creation of the key is described later in this document).
![Authorize](https://bindapi.24unix.net/assets/bindAPI_api2.png)
And enter you API key:
![Enter Apikey](https://bindapi.24unix.net/assets/bindAPI_api3.png)
After successful authorization you can use the APi via the OpenAPI Interface, e.g. call the /ping endpoint to check if the API is alive.
You have to click on „Try it out“:
![Try it out](https://bindapi.24unix.net/assets/bindAPI_api4.png)
And then hit Execute:
![Try it out](https://bindapi.24unix.net/assets/bindAPI_api5.png)
Of course, you can issue the same command in your shell:
`
curl -X 'GET' \
'https://ns1.24unix.net/api/ping' \
-H 'accept: application/json' \
-H 'X-API-Key: 61f27a57c9d1f.[truncated]'
`
A helpful tool when dealing with API is [Postman](https://https://www.postman.com/), if offers the same options as from the OpenAPI interface or via shell with curl.
![Php Interpreter](https://bindapi.24unix.net/assets/bindAPI_api6.png)
<a name="conclusion"></a> <a name="conclusion"></a>
# 6. Conclusion # 6. Conclusion