App47 APIv2 Overview
The App47 platform allows you to programmatically obtain data related to your account. For instance, you can easily obtain a list of all the apps or users in your account. Moreover, you'll be able to manage a majority of elements within your account such as creating apps, uploading builds, associating users to groups and the like.
Unlike the previous API, the APIv2 is based on a Member access token instead of an Account access token. The motivation for this was two-fold:
- First, the ability to provide audit logs relative to a member
- Second, to utilize the same access controls for the portal on the API.
This means that, with the member-based token, if a member does not have access to an app, they cannot view, update, nor delete it. With the previous account-based token, there exists access for everyone with no ability to log who did what.
Please note, the HTTP endpoint used in the examples is https://cirrus.app47.com, however if you are working in a different environment, the server url will change, but the path will be the same.
Access-Token
Once you have obtain your member based access token, you will include it in any APIv2 request as a header parameter "Access-Token." You can verify access to the APIv2 end point using the ping method.
To obtain your member based token, log in to the portal and hover over Profile and click on My info. On this page you will find your email, name, password, and access token. Keep this token private as it is unique to you and is just as secret as your password.
curl -H"Access-Token: <<your token>>" https://cirrus.app47.com/api/v2
If valid, it will return a result with:
-
Success set to true
-
A message
-
A md5 hash of the results element
-
HTTP result code 200
{ "results": { "message":"Valid token", "success":true }, "md5":"896d94e5e2f4eb6b6bfa19144c7794e5" }
If invalid, it will return a result with:
-
Success set to false
-
A message indicating the error
-
A md5 has of the results element
-
HTTP result code that is *not* 200
{ "results": { "message":"Valid token", "success":true }, "md5":"896d94e5e2f4eb6b6bfa19144c7794e5" }
All data is returned in the JSON format.
Restful URLs
All URLs in this API are Restful and following the pattern below.
URLs:
Action | HTTP method | Example URL |
---|---|---|
List all | GET | https://cirrus.app47.com/api/v2/apps |
Show | GET | https://cirrus.app47.com/api/v2/apps/<<id>> |
Create | POST | https://cirrus.app47.com/api/v2/apps |
Update | PUT | https://cirrus.app47.com/api/v2/apps/<<id>> |
Delete | DELETE | https://cirrus.app47.com/api/v2/apps/<<id>> |
Comments
0 comments
Please sign in to leave a comment.