OpenapiClient - the Ruby gem for the Affix API
The affixapi.com API documentation.
Affix API is an OAuth 2.1 application that allows developers to access customer data, without developers needing to manage or maintain integrations; or collect login credentials or API keys from users for these third party systems.
Affix API follows the OAuth 2.1 spec.
As an OAuth application, Affix API handles not only both the collection of sensitive user credentials or API keys, but also builds and maintains the integrations with the providers, so you don't have to.
in order to get started, you must:
client_idhttps://connect.affixapi.com
with the appropriate query
parameters)authorization_code we will send to your redirect URI after
the sign in flow is complete and exchange that authorization_code for
a Bearer tokeneyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q
employees endpoint sample:curl --fail \\
-X GET \\
-H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q' \\
'https://dev.api.affixapi.com/2023-03-01/xhr/employees'
eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg
employees endpoint sample:curl --fail \\
-X GET \\
-H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg' \\
'https://api.affixapi.com/2023-03-01/xhr/employees'
We support brotli, gzip, and deflate compression algorithms.
To enable, pass the Accept-Encoding header with one or all of the values:
br, gzip, deflate, or identity (no compression)
In the response, you will receive the Content-Encoding response header
indicating the compression algorithm used in the data payload to enable you
to decompress the result. If the Accept-Encoding: identity header was
passed, no Content-Encoding response header is sent back, as no
compression algorithm was used.
An exciting feature for HR/Payroll modes are webhooks.
If enabled, your webhook_uri is set on your client_id for the
respective environment: dev | prod
Webhooks are configured to make live requests to the underlying integration
1x/hr, and if a difference is detected since the last request, we will send a
request to your webhook_uri with this shape:
{
added: <api.v20230301.Employees>[
<api.v20230301.Employee>{
...,
date_of_birth: '2010-08-06',
display_full_name: 'Daija Rogahn',
employee_number: '57993',
employment_status: 'pending',
employment_type: 'other',
employments: [
{
currency: 'eur',
effective_date: '2022-02-25',
employment_type: 'other',
job_title: 'Dynamic Implementation Manager',
pay_frequency: 'semimonthly',
pay_period: 'YEAR',
pay_rate: 96000,
},
],
first_name: 'Daija',
...
}
],
removed: [],
updated: [
<api.v20230301.Employee>{
...,
date_of_birth: '2009-11-09',
display_full_name: 'Lourdes Stiedemann',
employee_number: '63189',
employment_status: 'leave',
employment_type: 'full_time',
employments: [
{
currency: 'gbp',
effective_date: '2023-01-16',
employment_type: 'full_time',
job_title: 'Forward Brand Planner',
pay_frequency: 'semimonthly',
pay_period: 'YEAR',
pay_rate: 86000,
},
],
first_name: 'Lourdes',
}
]
}
the following headers will be sent with webhook requests:
x-affix-api-signature: ab8474e609db95d5df3adc39ea3add7a7544bd215c5c520a30a650ae93a2fba7
x-affix-api-origin: webhooks-employees-webhook
user-agent: affixapi.com
Before trusting the payload, you should sign the payload and verify the
signature matches the signature sent by the affixapi.com service.
This secures that the data sent to your webhook_uri is from the
affixapi.com server.
The signature is created by combining the signing secret (your
client_secret) with the body of the request sent using a standard
HMAC-SHA256 keyed hash.
The signature can be created via:
HMAC with your client_secretHMAC with the payloadSample typescript code that follows this recipe:
import { createHmac } from 'crypto';
export const computeSignature = ({
str,
signingSecret,
}: {
signingSecret: string;
str: string;
}): string => {
const hmac = createHmac('sha256', signingSecret);
hmac.update(str);
const signature = hmac.digest('hex');
return signature;
};
While verifying the Affix API signature header should be your primary method of confirming validity, you can also whitelist our outbound webhook static IP addresses.
dev:
- 52.210.169.82
- 52.210.38.77
- 3.248.135.204
prod:
- 52.51.160.102
- 54.220.83.244
- 3.254.213.171
Open endpoints (not gated by an API key) (applied at endpoint level):
Gated endpoints (require an API key) (applied at endpoint level):
client_id)Things to keep in mind:
/orders,/items,/identity,This SDK is automatically generated by the OpenAPI Generator project:
To build the Ruby code into a gem:
gem build openapi_client.gemspec
Then either install the gem locally:
gem install ./openapi_client-1.0.0.gem
(for development, run gem install --dev ./openapi_client-1.0.0.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'openapi_client', '~> 1.0.0'
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'openapi_client'
# Setup authorization
OpenapiClient.configure do |config|
# Configure API key authorization: access-token
config.api_key['access-token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['access-token'] = 'Bearer'
end
api_instance = OpenapiClient::Class20230301Api.new
begin
#Company
result = api_instance.xhr_companies20230301
p result
rescue OpenapiClient::ApiError => e
puts "Exception when calling Class20230301Api->xhr_companies20230301: #{e}"
end
All URIs are relative to https://api.affixapi.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| OpenapiClient::Class20230301Api | xhr_companies20230301 | GET /2023-03-01/xhr/company | Company |
| OpenapiClient::Class20230301Api | xhr_employees20230301 | GET /2023-03-01/xhr/employees | Employees |
| OpenapiClient::Class20230301Api | xhr_groups20230301 | GET /2023-03-01/xhr/groups | Groups |
| OpenapiClient::Class20230301Api | xhr_identity20230301 | GET /2023-03-01/xhr/identity | Identity |
| OpenapiClient::Class20230301Api | xhr_payruns20230301 | GET /2023-03-01/xhr/payruns | Payruns |
| OpenapiClient::Class20230301Api | xhr_payslips20230301 | GET /2023-03-01/xhr/payruns/{payrun_id} | Payslips |
| OpenapiClient::Class20230301Api | xhr_time_off_balances20230301 | GET /2023-03-01/xhr/time-off-balances | Time off balances |
| OpenapiClient::Class20230301Api | xhr_time_off_entries20230301 | GET /2023-03-01/xhr/time-off-entries | Time off entries |
| OpenapiClient::Class20230301Api | xhr_timesheets20230301 | GET /2023-03-01/xhr/timesheets | Timesheets |
| OpenapiClient::Class20230301Api | xhr_work_locations20230301 | GET /2023-03-01/xhr/work-locations | Work locations |
| OpenapiClient::CoreApi | providers | GET /providers | Providers |
| OpenapiClient::ManagementApi | client | GET /2023-03-01/management/client | Client |
| OpenapiClient::ManagementApi | disconnect | POST /2023-03-01/management/disconnect | Disconnect token |
| OpenapiClient::ManagementApi | introspect | GET /2023-03-01/management/introspect | Inspect token |
| OpenapiClient::ManagementApi | token | POST /2023-03-01/management/token | Create token |
| OpenapiClient::ManagementApi | tokens | GET /2023-03-01/management/tokens | Tokens |
| OpenapiClient::ManagementApi | update_client | POST /2023-03-01/management/client | Update client |
| OpenapiClient::XHRVerticallyIntegratedApi | xhr_companies20230301 | GET /2023-03-01/xhr/company | Company |
| OpenapiClient::XHRVerticallyIntegratedApi | xhr_employees20230301 | GET /2023-03-01/xhr/employees | Employees |
| OpenapiClient::XHRVerticallyIntegratedApi | xhr_groups20230301 | GET /2023-03-01/xhr/groups | Groups |
| OpenapiClient::XHRVerticallyIntegratedApi | xhr_identity20230301 | GET /2023-03-01/xhr/identity | Identity |
| OpenapiClient::XHRVerticallyIntegratedApi | xhr_payruns20230301 | GET /2023-03-01/xhr/payruns | Payruns |
| OpenapiClient::XHRVerticallyIntegratedApi | xhr_payslips20230301 | GET /2023-03-01/xhr/payruns/{payrun_id} | Payslips |
| OpenapiClient::XHRVerticallyIntegratedApi | xhr_time_off_balances20230301 | GET /2023-03-01/xhr/time-off-balances | Time off balances |
| OpenapiClient::XHRVerticallyIntegratedApi | xhr_time_off_entries20230301 | GET /2023-03-01/xhr/time-off-entries | Time off entries |
| OpenapiClient::XHRVerticallyIntegratedApi | xhr_timesheets20230301 | GET /2023-03-01/xhr/timesheets | Timesheets |
| OpenapiClient::XHRVerticallyIntegratedApi | xhr_work_locations20230301 | GET /2023-03-01/xhr/work-locations | Work locations |
FAQs
Unknown package
We found that affixapi demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.