caren-api 0.4.11 → 0.4.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.rdoc +1 -33
- data/VERSION +1 -1
- data/caren-api.gemspec +2 -2
- data/certs/caren-api.pub +9 -8
- metadata +3 -3
data/README.rdoc
CHANGED
@@ -1,38 +1,6 @@
|
|
1
1
|
= Caren API reference implementation
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
== Getting started
|
6
|
-
|
7
|
-
To get started you will need a care provider API private/public keypair.
|
8
|
-
|
9
|
-
* Generate a private key using: pk = Caren::Api.generate_private_key
|
10
|
-
* Extract the public key from it: pk.public_key
|
11
|
-
* Send the public key to info@caren-cares.com with an access request.
|
12
|
-
* Create an Api session and fill your private key and your care provider url (like https://example.caren-cares.com)
|
13
|
-
|
14
|
-
== Getting information from Caren
|
15
|
-
|
16
|
-
This implementation shows you how to get information from Caren. You can gather information about Links (linking your people to caren's),
|
17
|
-
care_providers (including updating your settings) and external_messages (chat messages between you and caren people).
|
18
|
-
|
19
|
-
== Providing information to Caren
|
20
|
-
|
21
|
-
Some information you can push to Caren (like updates to care_provider settings and new messages) using the basic API.
|
22
|
-
Additionally Caren requires you to provide XML resources for People (search) and Events (daterange).
|
23
|
-
You can specify your API base url within your care_provider settings. You are required to implement the following resources:
|
24
|
-
|
25
|
-
* Finding a person by identifier: GET [BASE_URL]/people/?uid=[VALUE]
|
26
|
-
* Finding a list of events for a given person: GET [BASE_URL]/people/[EXTERNAL_ID]/events?from=[DATE]&to=[DATE]
|
27
|
-
|
28
|
-
The uid is your public customer number for this person, the external_id is your internal identifier (usually database id) for this person.
|
29
|
-
These urls should yield Caren compatible XML (the included Caren objects for Event and Person can generate that for you)
|
30
|
-
|
31
|
-
== Push notifications of changes from Caren
|
32
|
-
|
33
|
-
Caren supports a push link. Caren will regularly post a XML file with changes (Links, CareProviders, ExternalMessages) to any url.
|
34
|
-
Passing this XML and the corresponsing header signature into `Caren::Api.incoming` will yield the updated Caren objects.
|
35
|
-
You can optionally specify a push url within your care_provider settings.
|
3
|
+
See https://www.carenzorgt.nl/pages/api
|
36
4
|
|
37
5
|
== Contributing to caren-api
|
38
6
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.4.
|
1
|
+
0.4.12
|
data/caren-api.gemspec
CHANGED
@@ -5,11 +5,11 @@
|
|
5
5
|
|
6
6
|
Gem::Specification.new do |s|
|
7
7
|
s.name = %q{caren-api}
|
8
|
-
s.version = "0.4.
|
8
|
+
s.version = "0.4.12"
|
9
9
|
|
10
10
|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
11
|
s.authors = ["Andre Foeken"]
|
12
|
-
s.date = %q{2011-11-
|
12
|
+
s.date = %q{2011-11-16}
|
13
13
|
s.description = %q{You can use this gem as inspiration of the base of your connections with Caren.}
|
14
14
|
s.email = %q{andre.foeken@nedap.com}
|
15
15
|
s.extra_rdoc_files = [
|
data/certs/caren-api.pub
CHANGED
@@ -1,8 +1,9 @@
|
|
1
|
-
-----BEGIN
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
/fZR+XGQyJ+vcO8MaTRUKs4l28Ih/
|
6
|
-
|
7
|
-
|
8
|
-
|
1
|
+
-----BEGIN PUBLIC KEY-----
|
2
|
+
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3sPP1w5IMHMFD2swbNl6
|
3
|
+
LBWBek8QckE9z0MRmIIe4hVTcQcoXRcZbhK3r3l8yFbYjWjxEuWgk1JTdLx5Y+Lj
|
4
|
+
P0tbF4C+yTRZr8FmbEBVJ6Gan0AV0rmPAGyDY8YrrO3FI9A3L0TP1ZYpIY6Lt33z
|
5
|
+
KXMECgHWpXmiQcvRPR2rXRrVZzC5m1zk/fZR+XGQyJ+vcO8MaTRUKs4l28Ih/hGX
|
6
|
+
XGUgT4IYMdF+CIaoympBs8iMcchY4IdnDFdtNgG328QZUouHAa/kp46SC1Xo2Dtw
|
7
|
+
NNrJxsbQQyeABNCopGmsBJMmwQPfsV4ICH1U0hkEzBF2LsWJKRk1scTtVYiB8Kcu
|
8
|
+
4QIDAQAB
|
9
|
+
-----END PUBLIC KEY-----
|
metadata
CHANGED
@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
|
|
5
5
|
segments:
|
6
6
|
- 0
|
7
7
|
- 4
|
8
|
-
-
|
8
|
+
- 12
|
9
9
|
segments_generated: true
|
10
|
-
version: 0.4.
|
10
|
+
version: 0.4.12
|
11
11
|
platform: ruby
|
12
12
|
authors:
|
13
13
|
- Andre Foeken
|
@@ -15,7 +15,7 @@ autorequire:
|
|
15
15
|
bindir: bin
|
16
16
|
cert_chain: []
|
17
17
|
|
18
|
-
date: 2011-11-
|
18
|
+
date: 2011-11-16 00:00:00 +01:00
|
19
19
|
default_executable:
|
20
20
|
dependencies:
|
21
21
|
- !ruby/object:Gem::Dependency
|