NumlookupAPI (Independent Publisher) (#2523)
* Add files via upload * Add files via upload * Add files via upload * Add files via upload
This commit is contained in:
Troy Taylor
GitHub
Родитель
039f3f5d60
Коммит
bf9a7b8769
|
|
@ -0,0 +1,186 @@
|
|||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "NumlookupAPI",
|
||||
"description": "Automate your phone number verification process by checking carrier information with our free and worldwide phone number lookup service.",
|
||||
"version": "1.0",
|
||||
"contact": {
|
||||
"name": "Troy Taylor",
|
||||
"url": "https://www.hitachisolutions.com",
|
||||
"email": "ttaylor@hitachisolutions.com"
|
||||
}
|
||||
},
|
||||
"host": "api.numlookupapi.com",
|
||||
"basePath": "/v1",
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"paths": {
|
||||
"/validate/{phone_number}": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"valid": {
|
||||
"type": "boolean",
|
||||
"description": "Whether valid.",
|
||||
"title": "Valid"
|
||||
},
|
||||
"number": {
|
||||
"type": "string",
|
||||
"description": "The number.",
|
||||
"title": "Number"
|
||||
},
|
||||
"local_format": {
|
||||
"type": "string",
|
||||
"description": "The local format.",
|
||||
"title": "Local Format"
|
||||
},
|
||||
"international_format": {
|
||||
"type": "string",
|
||||
"description": "The international format.",
|
||||
"title": "International Format"
|
||||
},
|
||||
"country_prefix": {
|
||||
"type": "string",
|
||||
"description": "The country prefix.",
|
||||
"title": "Country Prefix"
|
||||
},
|
||||
"country_code": {
|
||||
"type": "string",
|
||||
"description": "The country code.",
|
||||
"title": "Country Code"
|
||||
},
|
||||
"country_name": {
|
||||
"type": "string",
|
||||
"description": "The country name.",
|
||||
"title": "Country Name"
|
||||
},
|
||||
"location": {
|
||||
"type": "string",
|
||||
"description": "The location.",
|
||||
"title": "Location"
|
||||
},
|
||||
"carrier": {
|
||||
"type": "string",
|
||||
"description": "The carrier.",
|
||||
"title": "Carrier"
|
||||
},
|
||||
"line_type": {
|
||||
"type": "string",
|
||||
"description": "The line type.",
|
||||
"title": "Line Type"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Validate phone number",
|
||||
"description": "Validates any given phone number and returns its carrier and location information.",
|
||||
"operationId": "NumberGet",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "phone_number",
|
||||
"in": "path",
|
||||
"x-ms-summary": "Phone Number",
|
||||
"x-ms-url-encoding": "single",
|
||||
"description": "The phone number.",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "country_code",
|
||||
"in": "query",
|
||||
"x-ms-summary": "Country Code",
|
||||
"description": "The country code.",
|
||||
"required": false,
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/status": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"quotas": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"month": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "The total.",
|
||||
"title": "Total"
|
||||
},
|
||||
"used": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "The used number.",
|
||||
"title": "Used"
|
||||
},
|
||||
"remaining": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "The remaining number.",
|
||||
"title": "Remaining"
|
||||
}
|
||||
},
|
||||
"title": "Month"
|
||||
}
|
||||
},
|
||||
"title": "Quotas"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Check service status",
|
||||
"description": "Retrieve your current quota and usage.",
|
||||
"operationId": "StatusGet",
|
||||
"parameters": []
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {},
|
||||
"parameters": {},
|
||||
"responses": {},
|
||||
"securityDefinitions": {
|
||||
"api_key": {
|
||||
"type": "apiKey",
|
||||
"in": "header",
|
||||
"name": "apikey"
|
||||
}
|
||||
},
|
||||
"security": [],
|
||||
"tags": [],
|
||||
"x-ms-connector-metadata": [
|
||||
{
|
||||
"propertyName": "Website",
|
||||
"propertyValue": "https://numlookupapi.com/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Privacy policy",
|
||||
"propertyValue": "https://numlookupapi.com/privacy-policy/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Categories",
|
||||
"propertyValue": "Business Intelligence;Communication"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
{
|
||||
"properties": {
|
||||
"connectionParameters": {
|
||||
"api_key": {
|
||||
"type": "securestring",
|
||||
"uiDefinition": {
|
||||
"displayName": "API Key",
|
||||
"description": "The API Key for this api",
|
||||
"tooltip": "Provide your API Key",
|
||||
"constraints": {
|
||||
"tabIndex": 2,
|
||||
"clearText": false,
|
||||
"required": "true"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"iconBrandColor": "#da3b01",
|
||||
"capabilities": [],
|
||||
"publisher": "Troy Taylor",
|
||||
"stackOwner": "NumlookupAPI"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# NumlookupAPI
|
||||
Automate your phone number verification process by checking carrier information with our free and worldwide phone number lookup service.
|
||||
|
||||
## Publisher: Troy Taylor, Hitachi Solutions
|
||||
|
||||
## Prerequisites
|
||||
You must register for an account with [NumlookupAPI](https://app.numlookupapi.com/register).
|
||||
|
||||
## Obtaining Credentials
|
||||
Once logged into your account, go the [API Keys session of your dashboard](https://app.numlookupapi.com/api-keys).
|
||||
|
||||
## Supported Operations
|
||||
### Validate phone number
|
||||
Validates any given phone number and returns its carrier and location information.
|
||||
### Check service status
|
||||
Retrieve your current quota and usage.
|
||||
|
||||
## Known Issues and Limitations
|
||||
There are no known issues at this time.
|
||||
Загрузка…
Ссылка в новой задаче