unime api

3
UNI.ME API The UNI.ME API allows you to register and delete domain names programatically, using your own software and server. You can also create and delete URL Forwarding, Nameserver and Zone Records (A,TXT,AAAA,CNAME) in your account. This API is still under development, and will probably change over the next few months. The API is available to PRO members only. Overview Requests to the API are sent to the following url: http://uni.me/api.php Only one request can be processed at a time. So please wait for your current request to finish before sending another request. The request should have the following parameters. Request Parameter Explanation key Your key to access the API, available in your account settings. command 'REG', 'DEL', 'RREG', 'RDEL' domain The domain name you want to register. type Only used when create/delete records: 'URL', 'NS', 'A', 'TXT', 'AAAA', ' CNAME' record Only used when create/delete records. Contains the content of the record you create/delete Possible commands. Command Explanation REG Register a new domain name DEL Delete a domain name RREG Create a new url, nameserver or zone record RDEL Delete an url, nameserver or zone record The results are sent as a single number which is the result of the command. Result Explanation 1 – 22 Only appears when result is error. OK The command was successful

Upload: achic

Post on 22-Dec-2015

212 views

Category:

Documents


0 download

DESCRIPTION

UNI ME API

TRANSCRIPT

  • UNI.ME API

    The UNI.ME API allows you to register and delete domain names programatically, using your own software and server. You can also create and delete URL Forwarding, Nameserver and Zone Records (A,TXT,AAAA,CNAME) in your account. This API is still under development, and will probably change over the next few months. The API is available to PRO members only.

    OverviewRequests to the API are sent to the following url:

    http://uni.me/api.php

    Only one request can be processed at a time. So please wait for your current request to finish before sending another request. The request should have the following parameters.

    Request Parameter

    Explanation

    key Your key to access the API, available in your account settings.

    command 'REG', 'DEL', 'RREG', 'RDEL'domain The domain name you want to register.type Only used when create/delete records: 'URL', 'NS', 'A',

    'TXT', 'AAAA', ' CNAME'record Only used when create/delete records. Contains the content

    of the record you create/delete

    Possible commands.

    Command ExplanationREG Register a new domain nameDEL Delete a domain name RREG Create a new url, nameserver or zone recordRDEL Delete an url, nameserver or zone record

    The results are sent as a single number which is the result of the command.Result Explanation1 22 Only appears when result is error. OK The command was successful

  • Possible error results from the API:

    Result Explanation0 Invalid command (REG,DEL,RREG,RDEL)1 No domain name provided2 No valid API Key provided3 Account not verified 4 Domain does not exist in user account 5 API only available to PRO members6 Domain not available7 Max. 100 registrations/day for domains using premium TLD8 Invalid type (URL,NS,A,TXT,AAAA,CNAME)9 Zone Record could not be created10 No content for the record11 Zone exists already12 Max. 8 zone records per domain allowed13 No valid content for NS14 Nameserver already exists15 Nameserver could not be created16 Domains using premium TLDs can not create Nameserver17 URL record exists already18 URL could not be created19 Zone record does not exist20 Zone record could not be deleted21 URL record does not exist22 NS record does not exist

    Domain create/delete API request format:Requesthttp://uni.me/api.php?key=[API-KEY]&command=[COMMAND]&domain=[DOMAIN]

    Record create/delete API request format:Requesthttp://uni.me/api.php?key=[API-KEY]&command=[COMMAND]&domain=[DOMAIN]&type=[TYPE]&record=[RECORD ]

  • Example domain create API request format:Requesthttp://uni.me/api.php?key=89ee323r9u239&command=REG&domain=domainname.uni.me

    Example domain delete API request format:Requesthttp://uni.me/api.php?key=89ee323r9u239&command=DEL&domain=domainname.uni.me

    Example record create API request format:Requesthttp://uni.me/api.php?key=89ee323r9u239&command=RREG&domain=domainname.uni.me&type=A&record=1.2.3.4

    Example record delete API request format:Requesthttp://uni.me/api.php?key=89ee323r9u239&command=RDEL&domain=domainname.uni.me&type=A&record=1.2.3.4

    OverviewDomain create/delete API request format:Record create/delete API request format:Example domain create API request format:Example domain delete API request format:Example record create API request format:Example record delete API request format: