diff --git a/README.md b/README.md index 1ade5b2..8708c1f 100644 --- a/README.md +++ b/README.md @@ -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. -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) # 3. Installation @@ -321,7 +290,38 @@ Now we can finally begin to populate our configuration: # 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) # 6. Conclusion