Skip to content

epilot-dev/epilot-app-schufa

Repository files navigation

epilot MarketplaceApps Developer Docs

Prerequisites

Simple API to check a schufa report for a given person.

This app is built by epilot.

All non-prod environments solely use the TEST certificate. Only prod contains the PROD certificate.

TODO

  • Translations for the error/skip messages: send a language flag to the API
  • Temp access token by epilot is only valid for 30 minutes. How can we handle long running manual processing?

Development

npm install
npm run dev

Secrets

  1. Create base64 encoded version of certificate:
base64 -i /path/to/your/cert.crt | tr -d '\n' > cert.b64
  1. Set the secret to your local sst environment:
pnpm run sst secret set TestSchufaCert "$(cat TEST_cert.b64)"
  1. After you've set the local secret you need to deploy once
pnpm run sst deploy --stage <stage>

Manual Processing

Most of the API credit checks are automatic. However, sometimes the API returns a status code 202, which means a manual intervention by a Schufa employee is necessary. This can take a couple of hours and sometimes days. They work from Monday to Friday from 8 AM to 5 PM. In the test environment, manual processing is done more sporadically.

Around 0.03% of all requests require manual processing.

A StepFunction is excuted asynchronously when the API returns a 202 status code. It is a simple lambda which calls the Schufa API with the reportId (the async id for the procesing). If the request returns 202, it waits for 15 minutes up to 8h.

About

Schufa App for epilot

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages