zero/api-docs-mirror
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

first commit

Browse source
This commit is contained in:
Zero 2020-01-21 17:06:22 -05:00
commit 1e283771f3
4 changed files with 129 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

57
amino/docs.md Normal file
View file

@ -0,0 +1,57 @@
<details>
<summary>GET /api/v1/g/s/auid/</summary>
GET an AUID for this device
__query strings__
|name|description|required|
| - | - | - |
|deviceId|Same as NDCDEVICEID|True|
__request_headers__
|name|description|required|
| - | - | - |
|NDCDEVICEID|The device id generated by the app. See|True|
|NDC-MSG-SIG|Message signature (?) generated by the app|False|
|SMDEVICEID|I don't know, seems to be a non-string hex number|False|
</details>
<details>
<summary>POST /api/v1/g/s/device/</summary>
POST a device configuration
__request_headers__
|name|description|required|
| - | - | - |
|NDCDEVICEID|The device id generated by the app. See|True|
|NDC-MSG-SIG|Message signature (?) generated by the app|False|
|SMDEVICEID|I don't know, seems to be a non-string hex number|False|
```JSON
{
"deviceID": "... <device id generated by the app>",
"bundleID": "com.narvii.amino.master <android app package?>",
"clientType": "100 <always 100>",
"timezone": "-300 <timezone number code>",
"systemPushEnabled": "true <true by default on new install>",
"locale": "en_US <locale string>",
"deviceToken": "... <device token generated by the app>",
"deviceTokenType": "1 <always 1?>",
"timestamp": "1579580530965 <request time in ms>"
}
```
__responses__
- 200 - Device configured
Device configured
The device config was accepted
</details>

62
amino/docs.yml Normal file
View file

@ -0,0 +1,62 @@
globals:
request_headers:
"*":
- name: NDCDEVICEID
description: The device id generated by the app. See
required: true
- name: NDC-MSG-SIG
description: Message signature (?) generated by the app
required: false
- name: SMDEVICEID
description: I don't know, seems to be a non-string hex number
required: false
vars:
request:
POST:
body:
post_device:
lang: JSON
content:
{
"deviceID": "... <device id generated by the app>",
"bundleID": "com.narvii.amino.master <android app package?>",
"clientType": "100 <always 100>",
"timezone": "-300 <timezone number code>",
"systemPushEnabled": "true <true by default on new install>",
"locale": "en_US <locale string>",
"deviceToken": "... <device token generated by the app>",
"deviceTokenType": "1 <always 1?>",
"timestamp": "1579580530965 <request time in ms>"
}
response_body:
POST:
post_device:
200:
lang: JSON
content:
{
"api:statuscode": "0 <0 is success>",
"api:duration": "0.034s <operation time>",
"api:message": "OK <more detailed status>",
"api:timestamp": "2020-01-21T04:22:13Z <server time>",
"devOptions": "null <?>"
}
routes:
/api/v1/g/s/device/:
POST:
description: POST a device configuration
body: $request.POST.body.post_device
responses:
200:
title: Device configured
description: The device config was accepted
body: $response_body.POST.post_device.200
/api/v1/g/s/auid/:
GET:
description: GET an AUID for this device
"query strings":
- name: deviceId
description: Same as NDCDEVICEID
required: true