Folio Environments
There are several enviormnents exists which used for development and testing processes. Some of them contains a lot of data which useful for some kind of performance evaluation routines or use cases oclose to production environment. All the negotioation with these environments as usual conducted via auxiliary tools like Postman of those intergated in some IDE (like intelliJ IDEA).
The following are listed environment with description of used parameters.
1. Bugfest - UAT (close to production data)
Definition | Notes | |
---|---|---|
Data | About 7 milion records (approx) | |
Updating | On regular basis of "Rlease process" | |
Folio UI url | https://bugfest-goldenrod.folio.ebsco.com/ | 443 port |
OKAPI url | https://okapi-bugfest-goldenrod.folio.ebsco.com | https://edge-bugfest-goldenrod.folio.ebsco.com (or use 8000 port for EDGE) |
apikey | eyJzIjoiUEp2VVg1OTRlcyIsInQiOiJmczA5MDAwMDAwIiwidSI6ImZzMDkwMDAwMDAifQ== | Used for communication via EDGE-* modules only |
Credentials | folio:folio |
To access environment via EDGE module there is no need to perform nor pre-authentification or passing any specifc headers like X-Okapi-Tenant
, X-Okapi-Token
, username
or password
.
Only "apikey
" needs to be passed with rest of other as query parameters to provide access to Folio system. There is no need to specify 8000 port for edge address too.
Example of use cases:
1) Getting of instances from OKAPI service. In this case some kind of requitred data needs to be passed: tenant
as a header, and username
with password
as JSON payload:
1.1) First, have to get X-Okapi-Token
by logging in:
curl --request POST 'https://bugfest-goldenrod.folio.ebsco.com' \
--header 'Content-Type: application/json' \
--header 'x-okapi-tenant: some_tenant
' \
--data-raw '{"username":"some_username
","password":"some_password
"}'
1.2) Get instances from inventory-storage. Here we need to pass only apikey
as a query parameter.
curl --request GET 'https://bugfest-goldenrod.folio.ebsco.com/instance-storage/instances' --header 'x-okapi-tenant: some_tenant
' --header 'x-okapi-token: token_returned_by_login
' --header 'Content-Type: application/json'
2. Perf-env (data should is about the same as in the bugfest)
Definition | Notes | |
---|---|---|
Data | About 2 milion records (approx) | |
Updating | unknown | unknown |
Folio UI url | https://gcp1-us-east-1.int.aws.folio.org/ | 443 port |
OKAPI url | https://okapi-gcp1-us-east-1.int.aws.folio.org | https://edge-gcp1-us-east-1.int.aws.folio.org (or use 8000 port for EDGE) |
apikey | eyJzIjoiUEp2VVg1OTRlcyIsInQiOiJmczA5MDAwMDAwIiwidSI6ImZzMDkwMDAwMDAifQ== | Used for communication via EDGE-* modules only |
To access environment via EDGE module there is no need to perform nor pre-authentification or passing any specifc headers like X-Okapi-Tenant
, X-Okapi-Token
, username
or password
.
Only "apikey
" needs to be passed with rest of other as query parameters to provide access to Folio system. There is no need to specify 8000 port for edge address too.
Example of use cases:
1) Getting of instances from OKAPI service:
1.1) First, have to get X-Okapi-Token
by logging in. In this case some kind of requitred data needs to be passed: tenant
as a header, and username
with password
as JSON payload::
curl --request POST 'https://okapi-gcp1-us-east-1.int.aws.folio.org/authn/login' \
--header 'Content-Type: application/json' \
--header 'x-okapi-tenant: some_tenant
' \
--data-raw '{"username":"some_username
","password":"some_password
"}'
1.2) Get instances from inventory-storage. Here we need to pass only apikey
as a query parameter.
curl --request GET 'https://okapi-gcp1-us-east-1.int.aws.folio.org/instance-storage/instances' --header 'x-okapi-tenant: some_tenant
' --header 'x-okapi-token: token_returned_by_login
' --header 'Content-Type: application/json'
3. Folio/testing (reference data only)
You can download any environment from https://app.vagrantup.com/folio/boxes/testing to set it up locally.
Definition | Notes | |
---|---|---|
Data | reference only | |
Updating | unknown | unknown |
Folio UI url | https://folio-testing.aws.indexdata.com/ | 443 port |
OKAPI url | https://folio-testing-okapi.aws.indexdata.com | EDGE uses 8000 port |
apikey | eyJzIjoiNXNlNGdnbXk1TiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ== | Used for communication via EDGE-* modules only |
4. Folio/snapshot (reference data only)
You can download any environment from https://app.vagrantup.com/folio/boxes/snapshot to set it up locally.
Definition | Notes | |
---|---|---|
Data | reference only | |
Updating | unknown | unknown |
Folio UI url | https://folio-snapshot.aws.indexdata.com/ | 443 port |
OKAPI url | https://folio-snapshot-okapi.aws.indexdata.com | EDGE uses 8000 port |
apikey | eyJzIjoiNXNlNGdnbXk1TiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ== | Used for communication via EDGE-* modules only |
Here is the Postman collection file to perform instance request and EDGE-MOD-RTAC requests: Folio-edge.postman_collection.json
5. Scratch dev environment (for Gulfstream)
Definition | Notes | |
---|---|---|
Data | reference only | |
Updating | on demand | |
Folio UI url | https://gulfstream.ci.folio.org/ | |
OKAPI url | https://gulfstream-okapi.ci.folio.org | Needs x-okapi-token header to be requested |
Edge url | https://edge-pmh-gulfstream.ci.folio.org | Needs APIkey to be requested |
apikey | eyJzIjoiQlBhb2ZORm5jSzY0NzdEdWJ4RGgiLCJ0IjoiZGlrdSIsInUiOiJkaWt1In0 | Used for communication via EDGE-* modules only |