{ "opencollection": "1.0.0", "info": { "name": "MTN Agent Profile API", "version": "v1.0" }, "items": [ { "info": { "name": "agents", "type": "folder" }, "items": [ { "info": { "name": "View agent profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:agentId", "headers": [ { "name": "X-Authorization", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "ID of the agent. It could be MSISDN, email address, or any other agent identifier. if id is msisdn, format must be E.123" }, { "name": "fields", "value": "", "type": "query", "description": "Filter for parts of the agent profile to be returned. Use comma-separated values" } ] }, "docs": "Retrieves the profile of a MTN field agent." }, { "info": { "name": "To know if any given customer Id (MSISDN) is registered as an MTN field Agent or not", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:customerId/agentFlag", "headers": [ { "name": "X-Authorization", "value": "" } ], "params": [ { "name": "customerId", "value": "", "type": "path", "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier. if id is msisdn, format must be E.123" } ] }, "docs": "To know if any given customer Id (MSISDN) is registered as an MTN field Agent or not" }, { "info": { "name": "Update device information of a registered MTN Agent", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/:agentId/devices", "headers": [ { "name": "transactionId", "value": "" }, { "name": "X-Authorization", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "ID of the agent. It could be MSISDN, email address, or any other agent identifier. if id is msisdn, format must be E.123" } ] }, "docs": "Update device information of a registered MTN Agent. E.g. Updating the IMEI the Agent's assigned Point-of-Sale device" }, { "info": { "name": "submit app installation confirmation details to the API.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:agentId/tracking/", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "ID of the agent. It could be MSISDN, email address, or any other agent identifier. if id is msisdn, format must be E.123" } ] }, "docs": "This endpoint is used to submit app installation confirmation details to the API." } ] } ], "bundled": true }