Yedpay API Documentation

Description (Device List)

Show the list of the devices related to push notifications. (GET)

Queries

In order to search you can add in the url the follow parameters

* limit - control the records show on each page (if not set, default load 40 records)
* page - control load the number of the page

Example:

https://api-h2h-staging.yedpay.com/v1/devices?limit=50&page=1

End Point

https://api-h2h-staging.yedpay.com/v1/devices

Request Header

Request Header
#	Key	Value	Description
1	Authorization	Bearer {{access_token}}	Login Token

Body

Body
#	Name	Type	Description

Response

Response
#	Name	Type	Description
1	success	Boolean	Request device list Success or Fail
2	data	Array	Include all device's information (id, platform, token)

Success Response - data

Table Information
#	Key	Value	Description
1	id	String	Id of the Device
2	platform	String	Platform of the Device
3	provider	String	Push method of device's notification
4	name	String	Name of the Device
5	token	String	Token of the Device
6	enabled	Boolean	Device Enabled or Not
7	created_at	String	Created Date
8	updated_at	String	Updated Date

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "JwoMPpKy",
                        "platform": "ios",
                        "provider": "jpush",
                        "name": "xxx",
                        "token": "190e35f7e073ba880ea",
                        "enabled": true,
                        "created_at": "2017-09-01 17:10:51",
                        "updated_at": "2017-09-01 17:10:51"
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 1,
                        "count": 1,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }

Example Error Response

            {
                "success": false,
                "message": "Unauthenticated.",
                "status": 500
            }