DeployGate API

Description of the DeployGate API.

Endpoint

[POST] https://deploygate.com/api/users/[owner name]/apps

Please replace [owner name] by the app owner's user name.


Params

Param Description
token Your API key
file App file binary
message (Optional) Push message
distribution_key (Optional) Target Distribution Key
release_note (Optional) Distribution message

Example

## Upload sample.apk app package by curl
$ curl -F "file=@sample.apk" -F "token=YOUR_API_KEY" -F "message=sample" https://deploygate.com/api/users/YOUR_USER_NAME/apps

## With update package for distribution page
$ curl -F "file=@sample.apk" -F "token=YOUR_API_KEY" -F "message=sample" -F "distribution_key=[distribution_ey]" -F "release_note=sample" https://deploygate.com/api/users/YOUR_USER_NAME/apps

Replace [distribution_key] with your distribution page URL hash key.

https://deploygate.com/distributions/[distribution_key]


Endpoint

https://deploygate.com/api/users/[owner name]/apps/[app_id]/members

Please replace [owner name] and [app_id] by the app owner's name and app ID.


GET Retrieve a list of members.

Response Params

Param Description
usage Number of allocated members (used) and capacity allowed in your plan (max).
users A list of the app members, represented as an array of username and role hash.

role params: 1:Developer, 2:Tester


Example

## Use curl 
$ curl "https://deploygate.com/api/users/YOUR_USER_NAME/apps/[app_id]/members?token=YOUR_API_KEY"
## Get response 
{"error":false,"results":{"usage":{"used":1,"max":25},"users":[{"name":"user name","role":1}]}}

POST, DELETE Add or remove a member of the app.

Params

Param Description
token your API key
users Comma-separated list of username or email.
role (Optional) Please specify the corresponding number. 1:Developer, 2: Tester

If the role isn't specified, it will be set to 1 in default.


Example

## Add member by curl
$ curl -F "users=[user, user2]" -F "token=YOUR_API_KEY" https://deploygate.com/api/users/YOUR_USER_NAME/apps/[app_id]/members

## delete member by curl 
$ curl -X DELETE -F "users=[user, user2]" -F "token=YOUR_API_KEY" https://deploygate.com/api/users/YOUR_USER_NAME/apps/[app_id]/members