RapidAPI examples

Use the RapidAPI package as an editable starting point for calling an API subscribed to through RapidAPI. It supplies four request patterns; it is not a universal connector that discovers arbitrary API contracts.

Choose the service in your RapidAPI account first. Its current endpoint, required parameters and response schema determine the configuration you should deploy.

What the package contains

Install RapidAPI and open rapidapi.snippet:

The dotted names inside brackets, such as ['bincheck.valid'], are literal context keys. Preserve that spelling when using the output.

Configure the API contract and credentials

1. Copy the closest template into a customer-specific file and give it a unique name.
2. Set its URL to the subscribed API's actual endpoint, including the correct path and query parameters.
3. Set X-RapidAPI-Host to the API's hostname only. Keep any path in the URL, not in that header.
4. Set X-RapidAPI-Key using a named secret, for example {{ secret(rapidapi_key) }}.
5. Match each response JSONPath to the response returned by that service's current version.

The supplied BIN host default includes bincheck.io/api/v1, mixing hostname and path. Replace it from your service's request example before deployment; simply supplying a key is insufficient.

Example: send the mapped BIN value

Suppose the selected template's BIN argument names card.bin_number. The request must read that attribute at runtime. The packaged direct {{rapidapi_bincheck_bin}} substitution only inserts the argument text during snippet expansion.

Use this two-stage expression for the query value in your copied template:

{{ {{rapidapi_bincheck_bin}} }}

After the argument is supplied, it becomes:

{{ card.bin_number }}

Darwinium then reads and percent-encodes the attribute value when constructing the URL. Do not pre-encode the value again. Keep the provider's required query-parameter name and ensure the BIN is mapped before the operation runs.

The same literal-path problem exists in the mail-check example. Correct the runtime expression, then check whether the API expects an entire email or only a domain. If it expects a domain, map or derive that domain separately and reference it; changing expression syntax alone does not satisfy the API contract.

Configure geocoding examples

For forward geocoding, the template selects an identity address context and reads its street, city, state, postal and country fields. Select the context actually populated by your step. It maps coordinates into the selected address's geocoding fields and retains status/error fields under the RapidAPI integration context.

For reverse geocoding, select a context with latitude and longitude, such as browser geolocation when collected and available. The supplied output-address argument is not used by its response mapping: the mapped destination remains integrations.rapidapi['google_geo.address']. Change that response mapping in your custom copy if you need another destination.

For a direct Google API integration instead, use Google Geocoding.

Attach, inspect and use the result

Import the adapted file, add its operation to the step containing the input, and set the input-stage dependency. Make a consuming rule depend on this call.

The BIN example maps fields such as ['bincheck.valid'], ['bincheck.scheme'] and ['bincheck.issuer_name']; mail-check maps ['mailcheck.valid'], ['mailcheck.disposable'] and ['mailcheck.riskscore']. These mappings work only when the subscribed service returns the expected fields. Interpret provider-specific scores using that API's definitions.

Deploy to a test target and inspect one representative request and event. Confirm that the API receives a value rather than an attribute path, that the response fields land in the intended attributes, and that a rejected request follows your chosen fallback. Making your own integrations provides a complete custom API pattern when the supplied examples are not close to your service.