Globalr

## 🚀 Theneo

Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

**⚠️ Note:** All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://assets.website-files.com/61f7e03934c23c1dcc9c3cd4/6306089ecc13c15fe0a7e006_Main page_2 (with visual studoi code logo) 2.svg" alt="" height="237" width="322">

### Generate API Documentation

- Build interactive API docs
- Tailor you documentation
- Create and launch quickly
- Update easily within seconds
- Built for everyone
    

# Integrations

Import your collections manually or use our integrations to automatically migrate your work from:

- Swagger
- Postman
- Github
    

[  
](https://www.theneo.io/#)

[  
](https://app.theneo.io/signup)

Introduction

Authentication

Base URL

Response Format

Rate Limiting

Error Handling

API Reference

Feedback and Support

🚀 Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

⚠️ Note**:** All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://assets.website-files.com/61f7e03934c23c1dcc9c3cd4/6306089ecc13c15fe0a7e006_Main page_2 (with visual studoi code logo) 2.svg" alt="" height="168" width="200">

### Generate API Documentation

- Build interactive API docs
- Tailor you documentation
- Create and launch quickly
- Update easily within seconds
- Built for everyone
    

# Integrations

Import your collections manually or use our integrations to automatically migrate your work from:

- Swagger
- Postman
- Github

User

Creates a new customer for a business.

You must provide at least one of the following values in your request to this endpoint:

 *   `given_name`
 *   `family_name`
 *   `company_name`
 *   `email_address`
 *   `phone_number`

Login

Update Tokens

User information

Utilizes one or more supported query filters to search the associated customer profiles with a Theneo account.  
Without an explicit query filter, SearchCustomers returns all customer profiles based on given name and family name in alphabetical order.  
Under normal working conditions, newly created or modified customer profiles become available for the search operation in significantly less than 30 seconds. Occasionally, propagation of new or updated profiles can take up to a minute or longer, particularly during network outages and events.

Logout

All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API.  
Get sales data, itemize payments, push orders to POS, and more.

**⚠️ Note:** The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.

In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://media.geeksforgeeks.org/wp-content/cdn-uploads/20200318193845/Top-7-Payment-Gateway-APIs-That-Every-Developer-Must-Know.png">

As an organization, you need to be careful while choosing a payment gateway option. It should be according to the customer’s experience on your websites through to cash flow to online sales. Make sure that you take care of at least 5 things mentioned below while choosing a payment gateway… 

- **Security** should be the topmost priority. Make sure that it should be integrated with the 3D security and comply with the PCI Data Security Standard (PCI DSS).
- **Payout Time** should be less to credit money in your bank account.
- **Integration need to be easy and simple** or it can develop a custom-coded solution for your platform easily.
- **Multiple currencies** should be handled by the payment gateway for the customers using different currencies across the world.

Domain

Domain information

Register Domain

Renew Domain

Auto Renew Domain

Leverage all these API to build your own in-app payroll solution, customized for your users' needs

&lt;img src="https://516180.smushcdn.com/2880970/wp-content/uploads/2021/08/api-management-2200-2048x854.png?lossy=1&amp;strip=1&amp;webp=1" alt="">

#### How Are APIs Used By HR Software Providers?

Back in the bad old days before software that's hosted in the Cloud became the norm, APIs were designed to make it possible to connect different legacy software systems, which were often hosted on-premise (within the business location itself). Today, the ways in which APIs are applied is growing exponentially. Organisations with complex digital infrastructures use them to simplify data transfer. HR and ERP software providers use them to integrate seamlessly with other systems like Payroll and Time & Attendance. APIs facilitate data transfers that reduce the manual handling, time, and cost involved in importing and exporting (sharing) data.  

In combination with automated data validation (to check the accuracy and completeness of data that is uploaded to the system), the integrations between HR, Payroll and T&A solutions reduce processing times, decrease error rates, and eliminate the need for data double entry. Essentially, integrations are all about efficiency. They save you time, money, and energy.

#### APIs as HR and Payroll Software Enhancers

Most HR software Platforms provide APIs that you can use to integrate, automate, and orchestrate data sharing without writing code. In the HR and Payroll spaces, APIs make it easier to integrate and connect systems, services and data, create new user experiences, share information, and authenticate users. They enable transactions and algorithms and let you offer new services.

Using APIs, you can turn your HR software Platform into the source of truth in a digital ecosystem. With the right integrations, your HR Platform forms the hub in a spoke and wheel type configuration for real-time data sharing and improved decision-making across your entire organisation. Another benefit of using an HR [HR software Platform](https://www.subscribe-hr.com.au/blog/hr-software-from-product-to-platform) (as opposed to stand-alone HR solutions) with a high number of out-of-the-box integrations and an open API is that you will also be less dependent on any one vendor for managing the processes and tasks your business needs to digitise, automate and optimise. If you don’t like that particular product or service at some point in the future, or a better one becomes available, you can simply switch out one solution in your ecosystem for another via the API.

When you access pre-existing integrations through the vendor API instead of having new ones built (which might require the time and cost of a Developer), you save your business time and money. Here's an [estimate](https://blog.dreamfactory.com/api-calculator-understanding-the-costs-behind-building-an-api-based-application/) of what it costs to build a custom API from scratch:

> “An enterprise API costs an estimated $25,000-$30,000 to build, and then 50% of that amount per year to manage. Multiply that by 10 APIs and you have $275,000-$450,000 per year just so APIs can exist within your organisation. Everyone who wants to access an API must develop, test and implement custom code, at an estimated cost of $15,000 per integration, plus a 50% maintenance fee. Each API must also be secured, costing additional thousands of dollars.” 

No matter how sophisticated your HR solution (or suite of solutions) is, it will never cover all of the services you need or want to offer to your employees. Sometimes it will be necessary to exchange data with another service. Payroll is an excellent example. Or, you might want to make a completely new service available and that vendor only offers it through an API. APIs also happen to make life easier for your employees - if your HR software provider offers single sign-on, that means you can combine access to all the different software products you use via a single logon - meaning you give your people one place to go and help themselves to al the different business systems they need.

Modify Domain records

Change domain contact information

Change domain nameservers(DNS)

Change domain additional field

NameServer bulk update

&lt;img src="https://www.qed42.com/sites/default/files/styles/social_media/public/2021-10/SE4 chrome dev tool-100.jpg?itok=qBl50Vgs" alt="">

All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage below mentioned API.s

Transfer Domain

Retrieve all the branches associated with the account

Check transfer type

Transfer domain

Theneo Demo TechCrunch

globalr_v2

Production

Sandbox

<p class="slate-p" placeholder="Type / for widgets">Welcome to the <span style="color:#CC0000" class="slate-color">BETA</span> Globalr API documentation. This API allows developers to interact with the Globalr system programmatically, providing a set of endpoints and functionalities to manage domains, user accounts, and more. 
</p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">To switch to the first version you can follow the link </strong><a href="https://globalr.com/doc/api/index.html" target="_blank">https://globalr.com/doc/api</a></p></div></div><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets">Example implementation in <a href="https://github.com/davitGlobalr/global_r_library" target="_blank">Github</a> </p></div></div><p class="slate-p" placeholder="Type / for widgets"></p>

 Globalr API documentation. This API allows developers to interact with the Globalr system programmatically, providing a set of endpoints and functionalities to manage domains, user accounts, and more. 


<p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-backgroundColor">To access the Globalr API, you&apos;ll need to authenticate your requests using API keys. Every request must include an API key in the </span></span><span style="color:rgb(56, 67, 91);font-size:12px" class="slate-color"><code style="color:rgb(56, 67, 91);font-size:12px" class="slate-code">Authorization</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-backgroundColor"> header.</span></span></p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-25-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="keep-markup drop-tokens"><div class="slate-code_line">Authorization: Bearer YOUR_API_KEY</div></code></pre><p class="slate-p" placeholder="Type / for widgets"></p>

To access the Globalr API, you'll need to authenticate your requests using API keys. Every request must include an API key in the 

<p class="slate-p" placeholder="Type / for widgets">The base URL for all API endpoints is <span style="color:var(--light-text-content-color);font-size:12px" class="slate-color"><code style="color:var(--light-text-content-color);font-size:12px" class="slate-code">https://api.globalr.com/api/v2/</code></span>. Make sure to prepend this base URL to each endpoint path mentioned in the documentation.</p>

. Make sure to prepend this base URL to each endpoint path mentioned in the documentation.

<p class="slate-p" placeholder="Type / for widgets">The API supports JSON as the primary response format. All responses will have a consistent structure with relevant data and, where applicable, error information.</p>

The API supports JSON as the primary response format. All responses will have a consistent structure with relevant data and, where applicable, error information.

<p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-backgroundColor">To ensure fair usage and maintain system stability, the Globalr API implements rate limiting. Each API key is subject to a certain number of requests per minute. Per minute you can send </span></span><span style="color:rgb(56, 67, 91);font-size:12px" class="slate-color"><code style="color:rgb(56, 67, 91);font-size:12px" class="slate-code"><strong style="color:rgb(56, 67, 91);font-size:12px" class="slate-bold">128 request</strong></code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-backgroundColor">. If you exceed the rate limit, you will receive a </span></span><span style="color:rgb(56, 67, 91);font-size:12px" class="slate-color"><code style="color:rgb(56, 67, 91);font-size:12px" class="slate-code">429 Too Many Requests</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-backgroundColor"> response. Please refer to the response headers for information on the rate limit and the number of requests remaining.</span></span></p>

To ensure fair usage and maintain system stability, the Globalr API implements rate limiting. Each API key is subject to a certain number of requests per minute. Per minute you can send 

. If you exceed the rate limit, you will receive a 

 response. Please refer to the response headers for information on the rate limit and the number of requests remaining.

<p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:14px" class="slate-backgroundColor">The API follows standard HTTP status codes to indicate the success or failure of a request. Errors are returned with an appropriate status code and an error response body providing more information about the encountered issue.</span></span></p>

The API follows standard HTTP status codes to indicate the success or failure of a request. Errors are returned with an appropriate status code and an error response body providing more information about the encountered issue.

<p class="slate-p" placeholder="Type / for widgets">The API documentation is organized into different sections, each covering a specific aspect of the Globalr API. Below are the main sections of the API reference:</p><ol class="slate-ol"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold);font-size:14px" class="slate-color"><strong style="color:var(--tw-prose-bold);font-size:14px" class="slate-bold">Domains</strong></span>: Learn how to register, manage, and query domain information using the Globalr API.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold);font-size:14px" class="slate-color"><strong style="color:var(--tw-prose-bold);font-size:14px" class="slate-bold">Accounts</strong></span>: Explore endpoints related to user accounts, including authentication, profile management, and billing details.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold);font-size:14px" class="slate-color"><strong style="color:var(--tw-prose-bold);font-size:14px" class="slate-bold">Purchasing</strong></span>: Discover endpoints for purchasing new domains, managing renewals, and handling payment-related operations.</div></li></ol><p class="slate-p" placeholder="Type / for widgets">Feel free to navigate through the sections and explore the available endpoints for your desired functionality.</p>

The API documentation is organized into different sections, each covering a specific aspect of the Globalr API. Below are the main sections of the API reference:

Feel free to navigate through the sections and explore the available endpoints for your desired functionality.

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">If you have any questions, feedback, or need assistance while using the Globalr API, please reach out to our support team at <code class="slate-code">support@globalr.com</code>. We&apos;re here to help you integrate and make the most of our API.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">That&apos;s a general introduction to the Globalr API documentation. Remember to provide detailed information about each endpoint, including their parameters, request/response examples, and any additional considerations in the subsequent sections of the documentation.</p><p class="slate-p" placeholder="Type / for widgets"></p>

If you have any questions, feedback, or need assistance while using the Globalr API, please reach out to our support team at 

. We're here to help you integrate and make the most of our API.

That's a general introduction to the Globalr API documentation. Remember to provide detailed information about each endpoint, including their parameters, request/response examples, and any additional considerations in the subsequent sections of the documentation.

<p> This area you can explore endpoints related to user accounts, including authentication, profile management, and billing details.</p><p></p>

xplore endpoints related to user accounts, including authentication, profile management, and billing details.

<p>There are four block of contact information - Owner, Administrative, Technical and Billing. Each block could be updated seperately. While update of any information in some block, whole information of the block must be sent.</p><div><div></div></div>

There are four block of contact information - Owner, Administrative, Technical and Billing. Each block could be updated seperately. While update of any information in some block, whole information of the block must be sent.

<p> Transfer procedure divorced to two type.</p><ul><li><div>transfer must be done in GlobalR system</div></li><li><div>transfer from other registrar</div></li></ul><p>In any case more preferable make two request first check domain can be transferred or not (a</p>

 Transfer procedure divorced to two type.

In any case more preferable make two request first check domain can be transferred or not (and which way it can be transferеd), second send transfer code.

If domain that must be transferеd registered thru globalr.com, in checking part our system will generate inner transfer code and will send to admin email.

Other ways you must send transfer code, that you get from losing registrar or registry. 