You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: wscli-php-sdk/swagger-php-sdk/SwaggerClient-php/autoload.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
*
6
6
* The API provides normal file based access to all common banks in Finland via WebServices channel on the service side, including certificate enrollment (PKI) with automatic renewals. Additionally, user account management, password recovery, and SMS based 2nd or Multi Factor Authentication (MFA) are provided (AWS Cognito Your User Pool). Access is secured with HTTPS/TLS (AWS API Gateway), using email address as username and password. On login, password is RSA encrypted along with dynamic parameters fetched from the service (username specific challenge response). Every integrator has own API Key and every user account belongs to one integrator. Certificate sharing between accounts is possible under the same integrator API Key, meaning that the enrolled bank connection certificates are shared. Under the same email address / username, both *admin* and *data* accounts must be used as they have separate passwords and differing functions.
Copy file name to clipboardExpand all lines: wscli-php-sdk/swagger-php-sdk/SwaggerClient-php/docs/Api/AccountApi.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -160,7 +160,7 @@ No authorization required
160
160
161
161
Register
162
162
163
-
You need to register both *admin* and *data* accounts with the same email address. Both accounts share the same data, but are used for different purposes. *Admin* account must be registered first, then *data* account. *Admin* account is used to configure setup with **Certs** and **Pgp** operations, while the *data* account is used with **Files** operations only. Both accounts use **Account** and **Session** operations. *Admin* account always requires SMS MFA during login, whilst *data* account does not. Generally, the *data* account is considered *read-noly* when no PGP keys are configured, since PGP Keys are used to verify file upload signatures and are thus required to successfully upload files with **Files** *UploadFile* operation. Registrations are independent for both accounts, *admin* and *data* and both require phone number and email verifications. `email` is the login username for both accounts and `mode` defines the selected "mode" for the login, i.e. *admin* or *data*. Before registration client must fetch challenge from server (see Account InitRegister operation) and pass it back within the `ChResp` parameter. The following parameters `name`, `phone`, and `company` are required and must be valid (`phone`, `email`) as they need to be confirmed before registration becomes successful and login possible. Client must RSA encrypt (OAEP padding) the _password_ and the challenge _timestamp_ as string in the form `password||timestamp`, base64 encode it and provide the resulting string as `Encrypted` parameter. The RSA encryption can be done e.g. for illustration purposes within command line with openssl rsautl: ``` echo -n 'Toddler_..123456789012345||1475175151231' | openssl rsautl -oaep -encrypt -pubin -inkey server_rsa_public_key.pem | base64 ``` The server's RSA public key is as follows: ``` -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAkuSaoSZztGAIGDTY7Rff psBHJJT1k207UodOJbYFhHAq0lWJnvMPLl5Q1DUUZdTGtTdL8Dsaj/Bo2+gSykMM R5QiKewvQsLfvqjwOO8JDItnhJl0lUqcPpdQV4M/Ai3YNRjNcVy4a+pichqtSAWl 9S1HV01MNeouk8PEr/zoUasmgfO3mz6N6XTUtF/tIi8K2kBOsLAtqltihFSd/zT8 ifYZE9cZTJ09lUs7kMz1wxFIsiegaE1jUYV+VSLu3PJ97oKhQpqop8EnkBAoBl6r mdmFryBQIdakPIdd4rO5Yg+to10n4u7Wij9ePIwWMfbqY4QoW5nXqMgFJQkIt4TG eQIDAQAB -----END PUBLIC KEY----- ``` - **NOTE:** Password must be at least 20 characters long, have lower and upper case letters, numbers, and special characters. - **NOTE:** Phone number must be provided with country code, e.g. `+358404982201`.
163
+
You need to register both *admin* and *data* accounts with the same email address. Both accounts share the same data, but are used for different purposes. *Admin* account must be registered first, then *data* account. *Admin* account is used to configure setup with **Certs** and **Pgp** operations, while the *data* account is used with **Files** operations only. Both accounts use **Account** and **Session** operations. *Admin* account always requires SMS MFA during login, whilst *data* account does not. Generally, the *data* account is considered *read-noly* when no PGP keys are configured, since PGP Keys are used to verify file upload signatures and are thus required to successfully upload files with **Files** *UploadFile* operation. Registrations are independent for both accounts, *admin* and *data* and both require phone number and email verifications. `email` is the login username for both accounts and `mode` defines the selected "mode" for the login, i.e. *admin* or *data*. Before registration client must fetch challenge from server (see Account InitRegister operation) and pass it back within the `ChResp` parameter. The following parameters `name`, `phone`, and `company` are required and must be valid (`phone`, `email`) as they need to be confirmed before registration becomes successful and login possible. Client must RSA encrypt (OAEP padding) the _password_ and the challenge _timestamp_ as string in the form `password||timestamp`, base64 encode it and provide the resulting string as `Encrypted` parameter. The RSA encryption can be done e.g. for illustration purposes within command line with openssl rsautl: ``` echo -n 'Toddler_..123456789012345||1475175151231' | openssl rsautl -oaep -encrypt -pubin -inkey server_rsa_public_key.pem | base64 ``` The **test** server's RSA public key is as follows: ``` -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAkuSaoSZztGAIGDTY7Rff psBHJJT1k207UodOJbYFhHAq0lWJnvMPLl5Q1DUUZdTGtTdL8Dsaj/Bo2+gSykMM R5QiKewvQsLfvqjwOO8JDItnhJl0lUqcPpdQV4M/Ai3YNRjNcVy4a+pichqtSAWl 9S1HV01MNeouk8PEr/zoUasmgfO3mz6N6XTUtF/tIi8K2kBOsLAtqltihFSd/zT8 ifYZE9cZTJ09lUs7kMz1wxFIsiegaE1jUYV+VSLu3PJ97oKhQpqop8EnkBAoBl6r mdmFryBQIdakPIdd4rO5Yg+to10n4u7Wij9ePIwWMfbqY4QoW5nXqMgFJQkIt4TG eQIDAQAB -----END PUBLIC KEY----- ``` The **production** server's RSA public key is as follows: ``` -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ EA7wx4l7P3eLsaEyK7ZRMEg5urEHwaEoY9LjkYcpMw 9gmPIi3RoGjQX7HzPad2D7ES2yIGdmyxjN8R2LyFa8 keEE+VY3ISYzP2cOjd/zDkX01yjDXQLRxntXbtqIyp GQAzmZbCyIB226ZKEE+ldh6MYyM41YWYikfocYssFE jY7fpPGeUg4FOmHmyWIZeMkXYovskoi1jZ1Ay1qn95 XlpA/Ptru2efro4T1xksv4WBBrj8bMNwdDpf4oyzH2 PKYkn3/KlNTBCHlAmzP0jd4pIaN0tAf2m8TcNq7kuB zyfs8AcCUj870p8SEiko0PMx6K+zVsTVWsxfUX+/+k mapmp/AwIDAQAB -----END PUBLIC KEY----- ``` - **NOTE:** Password must be at least 20 characters long, have lower and upper case letters, numbers, and special characters. - **NOTE:** Phone number must be provided with country code, e.g. `+358404982201`.
Copy file name to clipboardExpand all lines: wscli-php-sdk/swagger-php-sdk/SwaggerClient-php/docs/Api/CertsApi.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ Name | Type | Description | Notes
74
74
75
75
EnrollCert
76
76
77
-
Provide WS-Channel user id, _WsUserId_, _WsTargetId_, _Company_, and PIN _Code_ for _Bank_ certificate enrollment. _Company_ must match with the contract with the bank and is part of enrollment process. Note that certificate private key is securely generated and stored encrypted on service side and never leaves from there. Certificates are automatically renewed when needed.
77
+
Provide WS-Channel user id, _WsUserId_, _Company_, and PIN _Code_ for _Bank_ certificate enrollment. _Company_ must match with the contract with the bank and is part of enrollment process. Note that certificate private key is securely generated and stored encrypted on service side and never leaves from there. Certificates are automatically renewed when needed.
$api_instance = new Swagger\Client\Api\CertsApi();
94
94
$authorization = "authorization_example"; // string | Use _IdToken_ from the Login response as the Authorization header
95
95
$enroll_cert_req = new \Swagger\Client\Model\EnrollCertReq(); // \Swagger\Client\Model\EnrollCertReq | Certs parameters
96
-
$bank = "bank_example"; // string | *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `spankki`, or `alandsbanken`.
96
+
$bank = "bank_example"; // string | *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `pop`, `spankki`, or `alandsbanken`.
**bank** | **string**| *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `spankki`, or `alandsbanken`. |
113
+
**bank** | **string**| *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `pop`, `spankki`, or `alandsbanken`. |
$api_instance = new Swagger\Client\Api\CertsApi();
152
152
$authorization = "authorization_example"; // string | Use _IdToken_ from the Login response as the Authorization header
153
-
$bank = "bank_example"; // string | *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `spankki`, or `alandsbanken`.
153
+
$bank = "bank_example"; // string | *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `pop`, `spankki`, or `alandsbanken`.
154
154
$pgp_key_id = "pgp_key_id_example"; // string | Short version of a PGP Key id idenfiying the exported Private Key, e.g. `3A3A59B2`
**authorization** | **string**| Use _IdToken_ from the Login response as the Authorization header |
170
-
**bank** | **string**| *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `spankki`, or `alandsbanken`. |
170
+
**bank** | **string**| *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `pop`, `spankki`, or `alandsbanken`. |
171
171
**pgp_key_id** | **string**| Short version of a PGP Key id idenfiying the exported Private Key, e.g. `3A3A59B2` |
172
172
173
173
### Return type
@@ -190,7 +190,7 @@ Name | Type | Description | Notes
190
190
191
191
ImportCert
192
192
193
-
Provide _WsUserId_, _WsTargetId_, _Company_, _PrivateKey_, and _Certificate_ for importing existing WS Channel certificate and private key. _Company_ must match with the contract with the bank. Certificate(s) and private key(s) must be PEM formatted. - **NOTE:**_EncCcertificate_ and _EncPrivatekey_ are for DanskeBank only.
193
+
Provide _WsUserId_, _Company_, _PrivateKey_, and _Certificate_ for importing existing WS Channel certificate and private key. _Company_ must match with the contract with the bank. Certificate(s) and private key(s) must be PEM formatted. - **NOTE:**_EncCcertificate_ and _EncPrivatekey_ are for DanskeBank only.
$api_instance = new Swagger\Client\Api\CertsApi();
210
210
$authorization = "authorization_example"; // string | Use _IdToken_ from the Login response as the Authorization header
211
211
$import_cert_req = new \Swagger\Client\Model\ImportCertReq(); // \Swagger\Client\Model\ImportCertReq | Certs parameters
212
-
$bank = "bank_example"; // string | *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `spankki`, or `alandsbanken`.
212
+
$bank = "bank_example"; // string | *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `pop`, `spankki`, or `alandsbanken`.
**bank** | **string**| *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `spankki`, or `alandsbanken`. |
229
+
**bank** | **string**| *Bank* used for this operation, can have values of `nordea`, `osuuspankki`, `danskebank`, `aktia`, `sp`, `shb`, `pop`, `spankki`, or `alandsbanken`. |
0 commit comments