Connector
REST Web Service Connector
Your system is not on the list? If it has a REST API, Rapidi can usually connect to it.
Yes, if it has a REST API. Rapidi's REST Web Service connection moves data to and from REST-based services, and learns their objects and fields from a JSON Schema or Swagger 2.0 description. There is no single REST standard, so some services need extra setup. Tell us which service you plan to use and we will plan it with you.
- What it connects to
- Any REST-based web service, in the cloud or on your own network.
- Which way the data moves
- Both ways. Rapidi transfers data to and from the service.
- What you need
- The service address, a way to sign in, and ideally a JSON Schema or Swagger 2.0 description of the API.
What does this connector actually do?
The short version: you point Rapidi at the REST service, it reads the description of the API, and every object and field in that description becomes something you can map.
| What it reads | The objects and fields described in the service's JSON Schema or Swagger 2.0 metadata. You enter the metadata URL and press Read Design. |
|---|---|
| Direction | Both ways. The connection transfers data to and from the REST service. |
| How it signs in | No authentication, Basic (user ID and password), a token, a token request that returns a JWT bearer token, OAuth2 with Azure Active Directory, or NTLM on a local network. |
| Large data sets | Paged reads. A source filter such as limit=20 makes Rapidi add an offset to each request until no more data comes back. |
| Changed records only | Source Control adds the last value read to each request, so the service returns only newer records. |
| How often it runs | On a schedule you set. The shortest interval depends on your plan, from one hour on Entry down to one minute on Unlimited. |
| Where it can run | Straight to a REST endpoint on the internet, or through RapidiConnector for local installations and hosting you control. |
| Security | SSL (HTTPS) is a setting on the connection, and Rapidi recommends always using it. |
Which systems already connect this way?
Several systems in the Rapidi documentation run on this same connection, each with a JSON schema that defines what can be mapped.
| System | What it is used for | How it signs in | Who keeps the schema |
|---|---|---|---|
| Workday | Most often the source for HR data, such as employee master data, positions and the organisational hierarchy, going into an ERP or CRM | Workday's REST endpoints | The customer, so a new Workday field needs no change from Rapidi |
| Dayforce | Most often the target for employee time and pay data coming from another operational system | Token sign-in against the Dayforce API | The schema defines each Dayforce object that can be mapped |
| Storyblok | Fetching content from the Storyblok headless CMS | A Storyblok API token | Rapidi builds it from your API documentation and the scope of the integration |
REST services are built in many different ways, because there is no single standard for REST and JSON. Tell us which service you plan to use and for what, and we will tell you whether we have already used it with other customers.
Where do you go next?
Connectors
Every system Rapidi connects to
The full list, A to Z, with versions and how each one connects.
All connectors
Pricing
What Rapidi costs
Four plans, priced per subscription rather than per connector.
Plans
Your setup
Ask about your REST service
Tell us the service and what you plan to move, and we will say plainly what the setup involves.
Talk to a consultant
Frequently asked questions
Can Rapidi connect to a system that is not on the connector list?
Usually, if the system offers a REST web service. Rapidi reaches it through the generic REST Web Service connection. Some additional setup might be needed, so tell us which service you plan to use and for what, and we will say whether we have already used it with other customers.
How does Rapidi learn what is in a REST API?
From its description. If the service publishes a JSON Schema or Swagger 2.0 metadata, you enter that URL in the Metadata URL field and press Read Design. If it does not, we need the endpoint details from you, preferably as a JSON Schema.
Which sign-in methods does the REST connection support?
No authentication, Basic with a user ID and password, a token, a token request that returns a JWT bearer token, OAuth2 with Azure Active Directory, and NTLM on a local network. For OAuth2 with a directory other than Azure Active Directory, contact us.
Can it read large amounts of data in pages?
Yes. Add a source filter such as limit=20 to the transfer, and Rapidi adds an offset to each request until no more data comes back.
Can it move only the records that changed?
Yes. The field named in Source Control on the transfer is added to each request with the last value Rapidi read, so the service returns only newer records.
Does anything have to be installed on our side?
Not for a REST service Rapidi can reach over the internet. A new REST connection arrives with a RapidiConnector attached, and you delete it to let Rapidi connect directly. RapidiConnector is only needed for local installations, for hosting you control, or for NTLM sign-in.
What does the REST Web Service connector cost?
Nothing on its own. Rapidi is priced per subscription plan rather than per connector, so adding a REST service does not change the licence.
Is your system missing from the list?
Tell us which service you run and what has to move, and we will tell you plainly whether the REST connection covers it.