videocallshop API

Public tools and resources

BASE_URL/videocallshop-api.json

JSON with API method definitions for Advanced REST client (https://install.advancedrestclient.com/install).

BASE_URL/call-request.html

Client to enter in a waiting room as a client.

BASE_URL/store-user.html

Client to loggin as a store user, watch the queue and performs store user actions.

Utils

WEBAPP CLIENTE dev

https://videocallshop-webapp-dev.herokuapp.com

WEBAPP CLIENTE prod

https://videocallshop-webapp-prod.herokuapp.com

TOOL CLIENTE dev

https://videocallshop-api-dev.herokuapp.com/call-request.html

TOOL CLIENTE prod

https://videocallshop-api-prod.herokuapp.com/call-request.html

TOOL TIENDA dev

https://videocallshop-api-dev.herokuapp.com/store-user.html

TOOL TIENDA prod

https://videocallshop-api-prod.herokuapp.com/store-user.html

API dev

https://videocallshop-api-dev.herokuapp.com/

API prod

https://videocallshop-api-prod.herokuapp.com/

API methods

Common Status Codes

• 422 - Unprocessable Entity: Bad params.
• 400 - Bad Request.
• 401 - Unauthorized.
• 200 - OK.

GET - /

Ping.

Auth

public

POST - /authentication/store

Authenticate a store user.

Body example (Content-Type: application/json)

{
    "email": "maurocg89@gmail.com",
    "password": "sonserios10",
    "onesignalPlayerId": "6392d91a-b206-4b7b-a620-cd68e32c3a76"
}

Auth

public

GET - /stores

Get all the stores.

Auth

public

GET - /stores/:storeId

Get info of a particular store.

Auth

public

POST - /stores/:storeId/call-requests

Create a call request. It will automatically be added to the queue.

Body example (Content-Type: application/json)

{
    "email": "pacoamoroso@gmail.com",
    "name": "Paco",
    "lastName": "Amoroso",
    "onesignalPlayerId": "6392d91a-b206-4b7b-a620-cd68e32c3a76"
}

Auth

public

Status codes

• 409 - Conflict. message: 'Email already in use.'

Notes

Returns in a header Authorization a valid JWT Token for 2hs.

PATCH - /stores/:storeId/call-requests/:callRequestId

Finish a call request. It has to have CALLED status.

Body example (Content-Type: application/json)

{
    "status": "FINISHED"
}

Auth

storeUser.thisStore || (callRequestToken.thisStore && callRequestToken.thisCallRequest);

GET - /stores/:storeId/call-requests/:callRequestId

Get a particular call request.

Auth

storeUser.thisStore || (callRequestToken.thisStore && callRequestToken.inQueue)

DELETE - /stores/:storeId/call-requests/:callRequestId

Cancel a particular call request.

Auth

storeUser.thisStore || callRequestToken.thisStore && callRequestToken.thisCallRequest

GET - /stores/:storeId/waiting-room

Get a waiting room.

Auth

storeUser.thisStore || callRequestToken.thisStore && callRequestToken.inQueue

WebSocket - /waiting-room-socket

Connect with waiting room.

Events emitted

• WAITING_ROOM_SENDED: Emmit the hole waiting room for first time.
• QUEUE_CHANGED: Emmit only the queue.

Auth

storeUser.thisStore || (callRequestToken.thisStore && callRequestToken.inQueue)

Notes

Pass storeId query param.

POST - /stores/:storeId/calls

Call a call request.

Body example (Content-Type: application/json)

{
    "callRequestId": 4
}

Auth

storeUser.thisStore

Status codes

• 409 - Conflict. message: "You are already in call."
• 409 - Conflict. message: "Call request does not in queue."

GET - /stores/:storeId/calls/:callId

Get a particular call.

Auth

storeUser.thisStore || (callRequestToken.thisStore && callRequestToken.thisCall)

GET - /stores/:storeId/calls

Get the calls from the store.

Query Params (optional filters)

• callRequestId
• storeUserId
• state=[NEW | IN_QUEUE | CANCELLED | PROCESSING_CALL | CALLED | FINISHED ]

Auth

storeUser.thisStore || callRequestToken.thisCallRequest;

GET - /payment-options

Get the payment options.

GET - /shipping-options

Get the shipping options.

GET - /stores/:storeId/calls-requests/:callRequestId/purchase-orders

Get the purchase orders of a call request.

Auth

storeUser.thisStore || callRequestToken.thisStore

DELETE - /stores/:storeId/calls-requests/:callRequestId/purchase-orders/:purchaseOrderId

Delete a purchase orders of a call request.

Auth

storeUser.thisStore

POST - /stores/:storeId/calls-requests/:callRequestId/purchase-orders

Attach a purchase order in a call request.

Body example (Content-Type: application/json)

{
    "shippingOptionId": 1,
    "shippingPrice": 208.5,
    "paymentOptionId": 1,
    "province": "Santa Fe",
    "city": "Rosario",
    "address": "Zeballos 291 piso 6",
    "items": [
        {
            "productName": "Tela negra",
            "productDescription": "Retazo de tela negra",
            "unitPrice": 291.2,
            "quantity": 10
        },
        {
            "productName": "Cinta metrica",
            "unitPrice": 230,
            "quantity": 12
        }
    ]
}

Auth

storeUser.thisStore

GET - /stores/:storeId/mercadopago-authorization-url

Create a link to associate the store with Videocallshop Marketplace (Mercadopago).

Auth

public

GET - /mercadopago/store-authorization-code

Mercadopago redirect_uri. Stores authorization code and creates an access token for the store.

Auth

public